Docxy

Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.

Prerequisites

• Git
• Node.js, preferrably the LTS version

Get started

1. Install the Docxy CLI

2. Create your Docxy project:

   docxy create my-awesome-docs

3. Initialize Docxy in the project directory:

   cd my-awesome-docs
   docxy init

4. Add markdown pages in the contents directory which will serve as your documentation pages. You'll find two example pages already in there.

5. Edit the config.yaml file in the contents directory which contains configurations for the site. Edit those as per your need.

6. Anything you put in the static directory will be directly available in the root of your website. It is the right place to put your favicon.ico or CNAME file.

7. You can start a hot-reloading development server while working on your site using the following command:

   docxy serve

8. Build the documentation when you're ready for deployment using the following command:

   docxy build

   This will build an optimized static site inside the build directory from your markdown pages ready for deployment to production.

   You can deploy it anywhere you want - GitHub Pages, GitLab Pages, DigitalOcean, AWS, GCP, Azure, Heroku, or your own server!