Markdown Processor

Project to make personalized HTML or pdf files from Markdown files.

Examples

# Process the TEST.md process (by default it will be an HTML file)
md-processor process -f "TEST.md"

# Process multiple files
md-processor process -f "TEST.md" -f "TEST2.md"

# Use a specific theme
md-processor process -f "TEST.md" -t "rpg"

# Create a pdf file
md-processor process -f "TEST.md" -t "rpg" -o pdf

For more informations about the available commands : CLI documentation

To install

The CLI is available on npm.

npm i markdown-processor

Prerequisite

You must have pagedjs and pagedjs cli installed to generate pdf files.

npm install -g pagedjs-cli pagedjs

Themes available

• dark
• default
• rpg

Custom theme

If you are not interested about one of these theme, you can generate a theme squeleton and use your own theme!

If you are using a custom theme, you must have all the fonts locally.

Examples

# Generate locally a CSS Squeleton with a timestamped name
md-processor generate_squeleton

# Generate locally a CSS Squeleton with the name you've decided
md-processor generate_squeleton -n my_custom_theme

# Copy the CSS of an existing theme
md-processor generate_squeleton --theme rpg

Documentation

Links to the detailed documentation of the project.

Usage

• CLI
• Typo feature

Development

• Development docs
• Technologies/Tool used
• Unit Testing

Thanks

To make this project working correctly, we are using some policies/libraries...

First, the complete list is here and big up to all the people who worked on it!