Origami-plugin-markdown-docs NPM

Origami Markdown Documentation plugin

This is a simple yet powerful plugin for generating documentation from Markdown files in the fileystem on Origami. It comes out of the box with a theme, however it integrates nicely with origami-app-theme if you want to handle the rendering of the documents there.

Installation

yarn add origami-plugin-markdown-docs

Configuration

In your .origami file, add this to your plugins:

{
    ...
    "plugins": {
        "markdown-docs": true
    }
    ...
}

Options:

Option	Type	Required	Default	Description
`directory`	`string`	No	`'docs'`	Directory for the markdown files to read
`prefix`	`string`	No	`'/docs'`	URL prefix for serving the documentation
`themeTemplate`	`string`, `false`	No	`false`	Pass the response data to origami-app-theme to render
`cssFile`	`string`	No	`/docs/docs.css`	The path to the css file to include in each article
`cssHREF`	`string`	No		Override the default css file with a custom stylesheet link
`sidebarSkipRoot`	`boolean`	No	`true`	Don't include the root level folder in the sidebar
`logo`	`string`	No	`true`	URL of the logo to display at the top of the sidebar
`siteTitle`	`string`	No	`'Documentation`	Title of the sidebar next to the logo

Integration with `origami-app-theme`

In your .origami file, pass a template from your theme you want to render into themeTemplate:

{
    ...
    "plugins": {
        "markdown-docs": {
            "themeTemplate": "documentation-article"
        }
    },
    "apps": {
        "theme": "my-theme"
    }
    ...
}

Page template data

The theme template will be rendered with all the needed data on the response object.

Option	Type	Description
`body`	`string`	The markdown rendered into a HTML string
`tree`	`object`	A recursive tree of the entire file structure supplied in the `directory` option
`css`	`string`	A URL to the css sheet
`headings`	`array`	An array of headings for the current article (useful for building table's of contents)
`url`	`string`	The current url (useful for matching active links, etc)
`sidebarSkipRoot`	`boolean`	See `sidebarSkipRoot` in the options
`logo`	`string`	See `logo` in the options
`siteTitle`	`string`	See `siteTitle` in the options

Caching

By default, markdown-docs caches the rendered pages resulting in a much faster load time. To disable this, simply access a url with ?nocache at the end of the url to rebuild that individual page