{"repo":"crisp-oss/chappe","free":true,"listed":false,"github":"https://github.com/crisp-oss/chappe","clone":"git clone https://github.com/crisp-oss/chappe.git","description":"Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine.","language":"JavaScript","stars":238,"topics":["docs","docs-generator","developer","developer-documentation","developer-tool","blueprint","api-rest","api-documentation","documentation","documentation-tool"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"Developer Docs builder. Write guides in Markdown and references in API Blueprint. Comes with a built-in search engine. Chappe is a Developer Docs builder, that produces static assets. No runtime, just lightweight static files. It was built to address SaaS companies needs, and can serve as a first-class modern alternative to hosted services such as ReadMe. The reason behind why we made Chappe is the following: while looking for a Developer Docs builder at Crisp, all that we could find were either outdated open-source projects, or commercial documentation builders. We wanted a modern Developer Docs website hosted on our premises, as pure-static assets. The latter is especially important, as we do not want to rely on a plethora of external services that can go down anytime. Using Chappe is as easy as: 1. Writing all your docs in Markdown; 2. Building your docs in a single command; 3. Finally, deploying static build assets to your Web servers (or GitHub Pages, Cloudflare Pages, etc. — this can be automated via GitHub Actions ); 😘 Maintainer : @valeriansaliou Screenshots & Demo 👉 See a live demo of Chappe on the Crisp Developer Hub. 1️⃣ Chappe can generate your REST API reference: 2️⃣ It also generates Markdown-based developer guides: 3️⃣ Oh, and it also lets your users search anything in your Developer Docs: 👉 Note that the search engine feature is 100% local. This means that it does not run on an external service like Algolia, though it does provides similar search performanc","default_branch":null,"files":null,"tree":[],"storefront":"/r/crisp-oss","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/crisp-oss/chappe/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}