Docfy is a modular JavaScript tool to help build documentation sites. Its core has all the essential features to help you create a full-featured docs app while writing all your content in Markdown.
Read the DocsThe core package is framework agnostic so that we can have integrations with projects like Ember, React, Vue, Glimmer, Express and others.
We will process all your markdown content using remark. You can extend and modify the output by using their vast selection of plugins.
Write your documentation next to your packages in a monorepo project by specifying multiple source locations of markdown files.
We combine "demo" markdown files into a data structure representing a page; You can turn these demos into executable code. Learn more here.
You can extend and change what Docfy can do by writing plugins or using plugins from the community.
Link to other documents by using their file location, we will find these links and modify them to use the exact URL of that file.
We will process and expose all the headings present on a given page. This feature is perfect for building an "on this page" section.
Use the official Docfy integration with Ember to run your docs as an Ember app. Perfect for writing docs for design systems, UI libraries, and addons.
Write demos of your components in a single markdown file. We will extract and make them executable.
Write an HBS code block and have it rendered with the source code next to it.
Use the integrated components to get data out of the processed markdown files, pages, and much more.
Similarly to HTML in Markdown, you can have Handlebars code anywhere in the Markdown.
You can write your app to be Server Side Rendered, Docfy works in FastBoot without any issues.
You can pre-render all your documentation pages using prember. Docfy will inform prember about all the URLs it has.