Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
Install the Docxy CLI
Create your Docxy project:
docxy create my-awesome-docs
Initialize Docxy in the project directory:
cd my-awesome-docs docxy init
Add markdown pages in the
contentsdirectory which will serve as your documentation pages. You'll find two example pages already in there.
config.yamlfile in the
contentsdirectory which contains configurations for the site. Edit those as per your need.
Anything you put in the
staticdirectory will be directly available in the root of your website. It is the right place to put your
You can start a hot-reloading development server while working on your site using the following command:
Build the documentation when you're ready for deployment using the following command:
This will build an optimized static site inside the
builddirectory from your markdown pages ready for deployment to production.