docs.page sources content directly from any Open Source GitHub repository.
To get started, create an empty docs directory
and a config docs.json file, both at the root of
your repository.
docs/index.mdx
Create an index.mdx file at the root of
your /docs directory. docs.page supports nested
pages based on your directory structure of the directory.
Start by writing some Markdown content. Installation pages are always a great place to start!
Add a docs.json file to the root of the
repository to configure your project by adding a theme, search, navigation,
analytics and more.
Previewing docs locally with our new Local Preview Mode. Previewing changes on branches and pull requests works out of the box with zero configuration. Install our GitHub bot for preview assistance.
By using MDX we provide custom React components to help you build better documentation.
Using a custom domain name? Simply create a pull request & point your domain to our servers. We'll take care of the rest.
Install our GitHub bot on repositories using docs.page. Any new Pull Requests will automatically display a publicly available deployment preview URL for your documentation.
Add your DocSearch application ID to your configuration file and instantly get full blown documentation search for free, powered by Algolia.