https://github.com/paulledemon/browsedocs

A free and open-source documentation tool
https://github.com/paulledemon/browsedocs

browsedocs documentation documentation-generator documentation-tool documentation-website free-docs

Last synced: 11 months ago
JSON representation

A free and open-source documentation tool

• Host: GitHub
• URL: https://github.com/paulledemon/browsedocs
• Owner: PaulleDemon
• License: agpl-3.0
• Created: 2023-10-28T14:16:47.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2023-12-10T06:36:18.000Z (over 2 years ago)
• Last Synced: 2025-04-05T06:04:12.662Z (about 1 year ago)
• Topics: browsedocs, documentation, documentation-generator, documentation-tool, documentation-website, free-docs
• Language: JavaScript
• Homepage: https://browsedocs.com
• Size: 953 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: License.txt

Awesome Lists containing this project

README

          
# Documentation tool - BrowseDocs



  



A free and open-source documentation creation and hosting tool







You can use the site at [https://browsedocs.com](https://browsedocs.com) 

## Features

* Use markdown to write documentation.

* Easily create multi-paged documentation.

* Create multi-version documentation.

* Create Blogs and Tutorials.

* Create About page.

* Quick search.

* Allow user to switch theme light / dark

## How it works?

 1. Login with your Github account.

 2. Select repository with documentation.

 3. Ensure `.browsedocs.json` file has required contents to create document successfully.

 4. Save the project.

### Deployment:

If you are deploying on Render, Railway, Digital Ocean, You will be required to fire up different services. One for web other for celery.

You can make use of Railway to deploy your own instance.



  



### **Support Opensource**

Developing and maintaining open-source and free projects requires a significant commitment of time and effort. My goal is to transition to working on open-source projects on a full-time basis. If you'd like to support me and the open-source community consider making a small donation. You can have your logo/name on this [page](https://browsedocs.com/support/) .

[](https://www.buymeacoffee.com/ArtPaul)

**Other ways to support open-source**

* To dedicate more time to open-source You can purchase some of my production scale softwares on [Gumroad](https://paulfreeman.gumroad.com/)

* I also have production scale private projects (dating app, Social media, food delivery and more.), If you are interested, let me know