serve-markdown-it-template-default

serve-markdown-it-template-default

Simple default template for serve-markdown-it, supporting multiple color themes and configurable syntax highlighting.

README & DOCS TODO

Installation

yarn add serve-markdown-it-template-default

Developing

yarn gen-readme // update README.md
yarn docs // update DOCUMENTATION.md
yarn test // lint & mocha
yarn update-deps // bump all deps

Release History

See CHANGELOG.md for more information.

License

Distributed under the MIT license. See LICENSE.md for more information.

Contributing

• Fork it
• Create your feature branch (git checkout -b my-new-feature)
• Commit your changes (git commit -am 'Add some feature')
• Push to the branch (git push origin my-new-feature)
• Create a new Pull Request

API Reference

The standalone JSDoc reference can be found in DOCUMENTATION.md

Modules

serve-markdown-it-template-default

Simple default template for serve-markdown-it, supporting multiple color themes and configurable syntax highlighting.

Functions

genImageMarkdown(params) ⇒ string

Generate a markdown string to display an image at relPath.

serve-markdown-it-template-default

Simple default template for serve-markdown-it, supporting multiple color themes and configurable syntax highlighting.

License: MIT

genImageMarkdown(params) ⇒ string

Generate a markdown string to display an image at relPath.

Kind: global function
Returns: string - md

Param	Type	Description
params	object	params
params.relPath	string	path relative to content root path.
params.name	string	image alt text.