Skip to content
/ mdweb Public

A tool to convert markdown files into a static website

Notifications You must be signed in to change notification settings

domandlj/mdweb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

9 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MDWEB

MDWEB is a Rust command line tool to convet markdown files .md into an a static .html websites.

 _________________________________________
< Feed me markdown, i will make it HTML! >
 -----------------------------------------
        \
         \
            _~^~^~_
        \) /  o o  \ (/
          '_   -   _'
          / '-----' \

Usage

Place your .md files into a folder and execute mdewb with

Usage: mdweb --title <TITLE> --input <INPUT_FOLDER> --output <OUTPUT_FOLDER>

Options:
  -t, --title <TITLE>           Title of website
  -i, --input <INPUT_FOLDER>    Path to the input folder containing Markdown files
  -o, --output <OUTPUT_FOLDER>  Path to the output folder where HTML files will be saved
  -h, --help                    Print help

Building

Assuming you have rust and cargo.

$ cargo build --release    

Installation

$ cargo install --path .

Hyperlinks.

Suppose you have A.md and B.md, you can make a hyperlink from A to B with [link to B](B.md) inside A. This will reference B's HTML when compiled.

Latex

It has support for writing latex equations.

Styling

Save a styles.css file into your markdown website folder.

Embeddings

You can add custom HTML tags inside your .md files wrapping them with

```script
(your embbeded code) ```

Example

Link to example

About

A tool to convert markdown files into a static website

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published