Markdown files to static SPA Angular.js Application Generator
Must Install mrkdown package.
npm install -g mrkdownCreate a config file
mrkdown initConvert All markdown file to HTML
mrkdown buildConversion
| From File | To File |
|---|---|
| md | html |
| html | html |
| htm | html |
| txt | html |
Commands
Command - Init
mrkdown init, it will create a new mrkdown.config.json file.
{
"distFolderName": "dist",
"title": "My Notes",
"brandName": "My Notes",
"favIconUrl": "Image/image.png",
"users": [
{
userName: "Admin",
password: "admin@123",
displayName: "Admin",
imageUrl: "Image/image.png"
}
],
"useHash": true
}mrkdown.config.json
| Key | Meaning | Default |
|---|---|---|
| removeRightSideBar | removing the right side bar | true |
| distFolderName | build file will be there | "markdown-publish" |
| title | browser tab title | "Notes" |
| favIconUrl | fav icon url | NULL |
| skipFolders | conversion not applied those specified paths | ['.git', 'node_modules'] |
| skipFiles | conversion not applied those specified files | [] |
| home | it will enable the default home page setup | false |
| homeHtml | accept RAW html | NULL |
| homeHtmlUrl | Home page html file | NULL |
| users | Give the users to access you wep page | [] |
| useHash | it will enable the hash in the URL | true |
| prod | minified all the files | false |
Command - Build
mrkdown build, it will convert all Markdown file to HTML file.
mrkdown build --use-hash=true, enable the # in URL
mrkdown build --use-hash=false, remove the #! in URL
mrkdown build --use-hash=false --prod, remove the #! in URL and minified the files