MDWEB is a Rust-based command line tool designed to streamline the process of transforming Markdown files into static HTML websites. With simple commands, it allows for easy customization and supports links, LaTeX, and embedded scripts, making it a versatile solution for anyone looking to publish content online.
MDWEB is a powerful command line tool written in Rust that effortlessly converts Markdown files (.md) into static HTML websites. This tool simplifies the process of transforming your Markdown documents into visually appealing web pages, enabling developers, writers, and content creators to showcase their work online with ease.
Markdown to HTML Conversion: Just place your .md files into a designated folder, and with a simple command, MDWEB will generate corresponding HTML files.
Customizable Titles: The project allows you to specify a title for your website, ensuring that your online presence accurately reflects your content.
Easy Input and Output: Define the input directory containing your Markdown files and the output directory where the generated HTML files will be stored.
Hyperlink Support: Easily create hyperlinks between your Markdown files. For example, in A.md, you can link to B.md using the syntax: [link to B](https://github.com/domandlj/mdweb/blob/main/B.md), which makes navigation seamless once compiled into HTML.
LaTeX Support: Ideal for technical documents, MDWEB supports LaTeX equations, allowing for rich mathematical content inclusion.
Custom Styling: Enhance the appearance of your generated website by saving a styles.css file in your Markdown folder and linking it to your content.
HTML Embeddings: Users can incorporate custom HTML directly into their Markdown files by wrapping the code in triple backticks:
(your embedded code)
To use MDWEB, simply execute the following command in the terminal after setting up your Markdown files:
mdweb --title "My Website" --input <INPUT_FOLDER> --output <OUTPUT_FOLDER>
For a practical demonstration and further insights on the capabilities of MDWEB, refer to the example site which showcases the output of the tool.
No comments yet.
Sign in to be the first to comment.