markdown-reveal
v0.1.1
Published
convert your markdown file to a beautiful html page
Downloads
46
Maintainers
Readme
:eyes: Preview
:two_hearts: :email: Installation
npm
npm install markdown-reveal -g
yarn
yarn global add markdown-reveal
:smiling_imp: Usage
Usage: mk [option]
Options:
-v, --version Output the version number
-f, --file <file> The file path that to convert
-u, --output [file] The file path that to output
-l, --logProcess Log process
-o, --openInBrower Open in the brower
-h, --help Output usage information
e.g:
mk -f './demo.md' -u 'demo'
:wrench: Configuration
You can customize the configuration in config.yml
# @desc: Open html in brower
# @type: boolean
openInBrower: false
# @desc: Log process
# @type: boolean
logProcess: true
# @desc: html title
# @type: string
# @default: marker
title: 'marker'
# @desc: Whether to display the title number
# @type: boolean
showSerialNumber: false
# @desc: Whether to expand all nodes
# @type: boolean
openAllNode: false
# @desc: Additional custom scripts that need to be introduced
# @type: Array
# @example:
# scripts:
# - 'xxx1'
# - 'xxx2'
scripts:
# @desc: Additional custom links that need to be introduced
# @type: Array
# @example:
# links:
# - 'xxx1'
# - 'xxx2'
links:
:flashlight: TODOLIST
- [ ] Support convert folder
- [ ] Compress static resources
- [ ] link animate