Skip to content

Generate a static website from your mardown documentation.

License

Notifications You must be signed in to change notification settings

ziggornif/markassin

Repository files navigation

markassin

Generate a static website from your mardown documentation.

NPM Version Build Status Coverage Status Known Vulnerabilities

Installation

npm install -g markassin

Use

markassin <source> <target>

example

Options

  • -h, --help output usage information
  • -V, --version output the version number
  • -t --template generate html with a custom template
  • -f --force force generate (erase target dir if exists)

Commands

  • markassin <source> <target> Generate website from markdown source

Miscellaneous

Generator use Github markdown stylesheet to render html.

Templating

To generate custom html, markassin accept input template with --template t param.

Template format

module.exports = content => `<!DOCTYPE html>
  <html>
  <head>
    head stuff here
  </head>
  <body class="markdown-body">
  ${content} // markdown transformed is injected here
  </body>
  </html>`;
`

About

Generate a static website from your mardown documentation.

Resources

License

Stars

Watchers

Forks

Packages

No packages published