https://github.com/invertase/docs.page

Instant Open Source docs with zero configuration.
https://github.com/invertase/docs.page

documentation documentation-generator markdown-to-html

Last synced: 5 days ago
JSON representation

Instant Open Source docs with zero configuration.

• Host: GitHub
• URL: https://github.com/invertase/docs.page
• Owner: invertase
• License: apache-2.0
• Created: 2020-11-11T13:32:06.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-10-16T11:38:51.000Z (23 days ago)
• Last Synced: 2024-10-18T07:48:22.967Z (22 days ago)
• Topics: documentation, documentation-generator, markdown-to-html
• Language: TypeScript
• Homepage: https://docs.page
• Size: 21.7 MB
• Stars: 464
• Watchers: 10
• Forks: 76
• Open Issues: 45
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - invertase/docs.page - Instant Open Source docs with zero configuration. (hacktoberfest)

README

        


   



  Instant Open Source docs with zero configuration.





  

   

   

 





  Homepage • Documentation



## About

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 website

for each project is time consuming. Many common solutions to problems have to be duplicated, along with

dealing with overheads such as website maintenance & hosting.

Solutions such as [Jekyll](https://jekyllrb.com/docs/github-pages/), [Docusaurus](https://docusaurus.io/),

[docsify](https://docsify.js.org/#/) 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 public

GitHub repository. Features include:

- [Configurable](https://use.docs.page/configuration): Add your own logo, theme, analytics, navigation and more with a simple config file.

- [Previewing](https://use.docs.page/previews): View the documentation of any branch, pull request or specific commit, and a new Local Preview Mode.

- [GitHub Bot](https://use.docs.page/github-bot): Install our [GitHub bot](https://github.com/apps/docs-page) to automatically get a URL to pull request documentation previews.

- [Components](https://use.docs.page/components/accordion): Powered by [MDX](https://github.com/mdx-js/mdx), use React components such as Tabs (useful for projects with multiple languages) directly in your docs.

- [Search](https://use.docs.page/search): Easily add full search support powered by [DocSearch](https://docsearch.algolia.com/).

- [Custom Domains](https://use.docs.page/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.

## Should I use docs.page?

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.

## License

- See [LICENSE](/LICENSE)

---



  

    

  

  


    Built and maintained by Invertase.