{"id":22297754,"url":"https://github.com/paulledemon/browsedocs","last_synced_at":"2025-07-29T01:33:07.064Z","repository":{"id":210571740,"uuid":"711202291","full_name":"PaulleDemon/BrowseDocs","owner":"PaulleDemon","description":"A free and open-source documentation tool","archived":false,"fork":false,"pushed_at":"2023-12-10T06:36:18.000Z","size":976,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T06:04:12.662Z","etag":null,"topics":["browsedocs","documentation","documentation-generator","documentation-tool","documentation-website","free-docs"],"latest_commit_sha":null,"homepage":"https://browsedocs.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PaulleDemon.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"License.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-28T14:16:47.000Z","updated_at":"2023-12-09T01:17:51.000Z","dependencies_parsed_at":"2023-12-10T07:26:52.362Z","dependency_job_id":null,"html_url":"https://github.com/PaulleDemon/BrowseDocs","commit_stats":null,"previous_names":["paulledemon/browsedocs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/PaulleDemon/BrowseDocs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaulleDemon%2FBrowseDocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaulleDemon%2FBrowseDocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaulleDemon%2FBrowseDocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaulleDemon%2FBrowseDocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PaulleDemon","download_url":"https://codeload.github.com/PaulleDemon/BrowseDocs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PaulleDemon%2FBrowseDocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267616582,"owners_count":24116155,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["browsedocs","documentation","documentation-generator","documentation-tool","documentation-website","free-docs"],"created_at":"2024-12-03T17:51:17.046Z","updated_at":"2025-07-29T01:33:06.623Z","avatar_url":"https://github.com/PaulleDemon.png","language":"JavaScript","funding_links":["https://www.buymeacoffee.com/ArtPaul"],"categories":[],"sub_categories":[],"readme":"# Documentation tool - BrowseDocs\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"logos/browsedocs.svg\" alt=\"CupidCues icon\" width=\"200px\" height=\"200px\"/\u003e\n\u003c/p\u003e\n\nA free and open-source documentation creation and hosting tool\n\u003cbr/\u003e\n\u003cbr/\u003e\nYou can use the site at [https://browsedocs.com](https://browsedocs.com) \n\n\n## Features\n\n* Use markdown to write documentation.\n* Easily create multi-paged documentation.\n* Create multi-version documentation.\n* Create Blogs and Tutorials.\n* Create About page.\n* Quick search.\n* Allow user to switch theme light / dark\n\n\n\n\n\n## How it works?\n\n 1. Login with your Github account.\n 2. Select repository with documentation.\n 3. Ensure `.browsedocs.json` file has required contents to create document successfully.\n 4. Save the project.\n\n\n\n### Deployment:\n\nIf you are deploying on Render, Railway, Digital Ocean, You will be required to fire up different services. One for web other for celery.\n\nYou can make use of Railway to deploy your own instance.\n\n\u003ca href=\"https://railway.app?referralCode=BfMDHP\"\u003e\n  \u003cimg src=\"logos/railway.png\" alt=\"railway icon\" height=\"50px\"/\u003e\n\u003c/a\u003e\n\n\n### **Support Opensource**\n\nDeveloping 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/) .\n\n\n[\u003cimg src=\"https://github.com/PaulleDemon/PaulleDemon/blob/main/images/buy-me-coffee.png?raw=true\" height=\"100px\" width=\"350px\"\u003e](https://www.buymeacoffee.com/ArtPaul)\n\n**Other ways to support open-source**\n\n* To dedicate more time to open-source You can purchase some of my production scale softwares on [Gumroad](https://paulfreeman.gumroad.com/)\n\n* I also have production scale private projects (dating app, Social media, food delivery and more.), If you are interested, let me know","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulledemon%2Fbrowsedocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpaulledemon%2Fbrowsedocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpaulledemon%2Fbrowsedocs/lists"}