HelpProvides Markdown help files that integrate into the UI
This is a module for Project Forge. It provides Markdown help files that integrate into the UI
Licensed under CC0
Each web action provides a
key as the first argument to
If that key matches a Markdown file in
./doc/help, a help link will be rendered in the top navigation, linking to a modal containing an HTML version of the files contents.
As an example, the home page uses an key of
home, so the app will render the help content from
If the Markdown file contains a header as its first line, the header content will be used as the title.
Otherwise, the page’s title will be used.
_footer.md will be included in every help page, in the places you’d expect.