Skip to content

Simple tool to convert Markdown files to webpages

Notifications You must be signed in to change notification settings

VNA818/md-to-webpage

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

md-to-webpage

Simple tool to convert Markdown files to webpages with Github styling. Includes code highlighting and auto dark/light mode.

Example result

Install

npm install -g <path to folder>

Ex: npm install -g C:\Users\vna\Documents\Node\md-to-webpage

Usage

In a folder with markdown files run

md-to-webpage

Arguments

Argument Explanation
-dark Only include dark mode styling
-light Only include light mode styling
--headerprefix= String to append to header id's default is header- you can link to them by appending # to url
--baseUrl= Base url to link all css and image links to default is ./
--outputDir= Output directory for webpages default is ./output

Dependencies

md-to-webpage relies on some other great projects including:

marked

highlight.js

html-minifier

github-markdown-css

About

Simple tool to convert Markdown files to webpages

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages