MdCompiler

Node.js CLI to convert markdown files to html, with Github styling.

Example

Input

# I'm a Header

`python 
def foo():
    print("This is sort of cool.")
`

- Markdown is better than Word
- Microsoft Word is too complicated
- But we need easy ways to compile Markdown to HTML

Compile

>compile_md -f foo.md -o foo.html -s dark

Output

Setup

1. Download Node.js (what is Node.js?)
2. npm install -g git+https://github.com/jdoiro3/MdCompiler.git
3. compile_md -h

VScode Setup

Using Vscode and the Run on Save extension, you can sync a markdown file to an html output.

1. Download Run on Save
2. Open Vscode's settings.json and append the below entry

"emeraldwalk.runonsave": {
        "commands": [
            {
                "match": "\\.md$",
                "cmd": "compile_md -f \"${file}\" -o \"${fileBasenameNoExt}.html\" -s dark"
            },
        ]
    }