docs.page

Instant Open Source docs
with zero configuration.

1

Add a docs directory to your GitHub repository.

docs.page sources content directly from any Open Source GitHub repository.

To get started, create an empty docs directory at the root of your repository.

docsA few seconds ago
2

Create an index.mdx file.

docs/index.mdx
# Installation

```bash
npm install myawesomelib
```

Create a 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!

3

Checkout your new documentation!

Enter your GitHub repository URL above to view your new documentation!

Please enter a valid GitHub repository URL.

4

Learn more...

Configure

Add a docs.json file to the roof of the repository to configure your project by adding a theme, search, navigation, analytics and more.

Previews

Previewing changes on branches and pull requests works out of the box with zero configuration. Install our GitHub bot for preview assistance.

Components

By using MDX we provide custom React components to help you build better documentation.

Domains

Using a custom domain name? Simply create a pull request & point your domain to our servers. We'll take care of the rest.

GitHub Bot

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.

Search

Add your DocSearch application ID to your configuration file and instantly get full blown documentation search for free, powered by Algolia.