Skip to content

f3rno64/http-server-md-template-default

Repository files navigation

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

npm badge

pnpm add http-server-md-template-default
pnpm gen-readme // update README.md
pnpm docs // update DOCUMENTATION.md
pnpm test // lint & mocha
pnpm update-deps // bump all deps

See CHANGELOG.md for more information.

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

  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

The standalone JSDoc reference can be found in DOCUMENTATION.md

Modules

http-server-md-template-default

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

Functions

genImageMarkdown(params)string

Generate a markdown string to display an image at relPath.

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

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