Skip to content

Template for generating documentation using Flatdoc and Mermaid using multiple markdown files

Notifications You must be signed in to change notification settings

nathanoehlman/flatdoc-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flatdoc Template

A template for creating Flatdoc based documentation. This template has the added benefit of supporting multiple files, and also allows you to use Mermaid JS markdown charts.

The files to be included can be indicated via a comma-delimited list in the body data-files attribute.

The documents can deployed to a gh-pages branch by running gulp docs.

A Beefy server can be spun up to serve the files with npm start.

About

Template for generating documentation using Flatdoc and Mermaid using multiple markdown files

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published