Repository files navigation

Instant Open Source docs with zero configuration.

Homepage •Documentation

docs.page is a free Open Source project, allowing you to create instant, fast, beautiful documentation with zero configuration.

Documentation is an important aspect for many projects, however creating a custom documentation websitefor each project is time consuming. Many common solutions to problems have to be duplicated, along withdealing with overheads such as website maintenance & hosting.

Solutions such asJekyll,Docusaurus,docsify and many others are great projects, however still require custom setup for each project.

docs.page is designed to deliver instant documentation websites, with the content sourced directly from any publicGitHub repository. Features include:

• Configurable: Add your own logo, theme, analytics, navigation and more with a simple config file.
• Previewing: View the documentation of any branch, pull request or specific commit, and a new Local Preview Mode.
• GitHub Bot: Install ourGitHub bot to automatically get a URL to pull request documentation previews.
• Components: Powered byMDX, use React components such as Tabs (useful for projects with multiple languages) directly in your docs.
• Search: Easily add full search support powered byDocSearch.
• Custom Domains: Serve your documentation using your own domain.

Other useful features include:

• Global variable injection (for managing common variables across the project).
• Displaying assets using GitHub.
• Dark/Light mode.
• Responsive.
• Code block highlighting and content copying.
• Page redirects.
• Per-page metadata support via Frontmatter.

docs.page is a simple way to generate a documentation with zero effort. It generally works for documentation websites with a lot of Markdown based content. If you require features which are more specific to your own project a custom solution might work better.

• SeeLICENSE

Built and maintained byInvertase.