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.md file.

docs/index.md
# Installation

```bash
npm install myawesomelib
```

Create an index.md 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

Easily preview documentation changes to branches & pull requests. Use our GitHub bot for seamless integration.

Components

Use our built in React components or create your own for fully customizable documentation pages.

Domains

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

Coming Soon...