1.1.0 • Published 3 months ago

http-server-md-template-default v1.1.0

Weekly downloads
-
License
MIT
Repository
github
Last release
3 months ago

http-server-md-template-default

NPM Version Build Status Downloads Stats

Simple default template for http-server-md, supporting multiple color themes and configurable syntax highlighting.

README & DOCS TODO

Installation

npm badge

pnpm add http-server-md-template-default

Developing

pnpm gen-readme // update README.md
pnpm docs // update DOCUMENTATION.md
pnpm test // lint & mocha
pnpm 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

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

API Reference

The standalone JSDoc reference can be found in DOCUMENTATION.md

Modules

Functions

http-server-md-template-default

Simple default template for http-server-md, 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

ParamTypeDescription
paramsobjectparams
params.relPathstringpath relative to content root path.
params.namestringimage alt text.