Docxy is a React based open-source documentation site generator. Build beautiful, blazing fast documentation sites for your projects with just markdown.
docxy create my-awesome-docs
cd my-awesome-docs
docxy init
contents
directory which will serve as your
documentation pages. You'll find two example pages already in there.config.yaml
file in the contents
directory which contains
configurations for the site. Edit those as per your need.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.docxy serve
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!