1.2.1 • Published 7 years ago
markdown-markup-parser v1.2.1
MarkDown Markup Parser (MDMP) v1.2.1
If any of you have looked into making websites, you may have heard of SASS or programs like it that aim to simplify CSS. MDMP aims to do the same, but instead of CSS, it aims to simplify HTML using Markdown, built off of an existing package named Markdown-it. But what makes it different to any other Markdown parser? Some features are:
- The ability to add multiple pages of HTML into a single Markdown file
- Support for HTML tags that are not covered by Markdown
- The ability to add classes and ID's to almost anything
- A simplified way to add head information into an HTML document
- Proper indentation of HTML files
- Link outside scripts or stylesheets, including ones from CDNs
How to use:
Installing:
From NPM:
- Run
npm install -g markdown-markup-parserto download this package and dependencies - Once NPM is finished installing, run
mdmp --initto makeindex.mdwith starting syntax - Start using markdown!
- Once you have a page you want, simply run
mdmpto parse the markdown file into a html file
From Git or GitHub:
- Run
npm iin directory to install modules ** Optional: Runnpm install -g /path/to/directoryto use this module globally. If this is done, follow the steps in 'From NPM' - Once NPM is finished installing packages, run
node mdmp.js --initto makeindex.mdwith starting syntax - Start using markdown!
- Once you have a page you want, simply run
node mdmp.jsand the program will parse the markdown file into a html file
Syntax:
Syntax can be found here
An example of the syntax in use can be found at examples/index.md.
Command line flags
- --help, -h: Display help message
- --file, -f: Specify markdown file to read from (default: index.md in current directory)
- --dest, -d: Specify where you want files to be made (default: current directory)
- --tag, -t: Specify command tags (default: /!)
- --init: make a new markdown file with starters
- --mdhelp, -m: Get help for markdown parsing commands
- --version, -v: View version number
Want to contribute? Check out CHANGELOG.md and CONTRIBUTING.md