FeastLabs

FeastDocs: your folders are the navigation

FeastDocs turns folders of Markdown, HTML and SCSS into a fast documentation app. No database, no CMS, just files you already know how to version.

Documentation tends to rot for one reason: it lives somewhere other than the code. FeastDocs keeps it next to the code, as plain files, and turns them into a proper documentation site.

Files in, an app out

You write Markdown, HTML and SCSS. FeastDocs builds them into a fast, searchable documentation app. There is no database and no CMS: the docs are files, so they are reviewed and versioned exactly like the rest of your project.

Folders become the navigation

The structure of the site is the structure of your folders. Every top-level folder becomes a section in the navbar, and the pages inside it become its sidebar. Reorganising the docs is moving files around.

Built at build time

Markdown is compiled and syntax-highlighted when the site builds, so pages ship as ready-made HTML and load quickly.

Live components in the docs

Because FeastDocs is an Angular app, a page can include live Angular components, not just screenshots of them. Demos in the documentation are the real thing.

Open source

FeastDocs is open source and MIT-licensed, free for anyone to run their own documentation on.

Open FeastDocs to read its own docs, which are built with it.