SaaSHub helps you find the best software and product alternatives Learn more →
Top 23 documentation-tool Open-Source Projects
-
-
-
SurveyJS
Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
-
-
-
eleventy 🕚⚡️
A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
-
Gollum
A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
-
gutenberg
A fast static site generator in a single binary with everything built-in. https://www.getzola.org
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
-
-
hugo-blox-builder
😍 EASILY BUILD THE WEBSITE YOU WANT - NO CODE, JUST MARKDOWN BLOCKS! 使用块轻松创建任何类型的网站 - 无需代码。 一个应用程序，没有依赖项，没有 JS
-
-
-
The-Documentation-Compendium
📢 Various README templates & tips on writing high-quality documentation that people want to read.
-
-
compodoc
:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
-
-
BoostNote-App
Boost Note is a document driven project management tool that maximizes remote DevOps team velocity.
-
codecrumbs
Learn, design or document codebase by putting breadcrumbs in source code. Live updates, multi-language support and more.
-
Documize
Modern Confluence alternative designed for internal & external docs, built with Go + EmberJS (by documize)
-
-
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
At one point though I realized there is a scaling problem with my build minutes. I knew that golang has considerably faster builds and in my case the easy fix is swapping over to Hugo.
Project mention: Show HN: I made a better Perplexity for developers | news.ycombinator.com | 2024-05-08Hi HN,
I am Jiayuan, and I'm here to introduce a tool we've been building over the past few months: Devv (https://devv.ai). In simple terms, it is an AI-powered search engine specifically designed for developers.
Now, you might ask, with so many AI search engines already available—Perplexity, You.com, Phind, and several open-source projects—why do we need another one?
We all know that Generative Search Engines are built on RAG (Retrieval-Augmented Generation)[1] combined with Large Language Models (LLMs). Most of the products mentioned above use indexes from general search engines (like Google/Bing APIs), but we've taken a different approach.
We've created a vertical search index focused on the development domain, which includes:
- Documents: These are essentially the single source of truth for programming languages or libraries; I believe many of you are users of Dash (https://kapeli.com/dash) or devdocs (https://devdocs.io/).
- Code: While not natural language, code contains rich contextual information. If you have a question related to the Django framework, nothing is more convincing than code snippets from Django's repository.
- Web Search: We still use data from search engines because these results contain additional contextual information.
Our reasons for doing this include:
- The quality of the index is crucial to the RAG system; its effectiveness determines the output quality of the entire system.
- We focus more on the Index (RAG) rather than LLMs because LLMs evolve rapidly; even models performing well today may be superseded by better ones in a few months, and fine-tuning an LLM now has relatively low costs.
- All players are currently exploring what kind of LLM product works best; we hope to contribute some different insights ourselves (and plan to open source parts of our underlying infrastructure in return for contributions back into open source communities).
Some brief product features:
- Three modes: - Fast mode: Offers quick answers within seconds. - Agent mode: For complex queries where Devv Agent infers your question before selecting appropriate solutions. - GitHub mode(currently in beta): Links directly with your own GitHub repositories allowing inquiries about specific codebases.
- Clean & intuitive UI/UX design.
- Currently only available as web version but Chrome extension & VSCode plugin planned soon!
Technical details regarding how we build our Index:
- Documents section involves crawling most documentation sources using scripts inspired by devdocs project’s crawler logic then slicing them up according function/symbol dimensions before embedding into vector databases;
- Codes require special treatment beyond just embeddings alone hence why custom parsers were developed per language type extracting logical structures within repos such as architectural layouts calling relationships between functions definitions etc., semantically processed via LMM;
- Web searches combine both selfmade indices targeting developer niches alongside traditional API based methods. We crawled relevant sites including blogs forums tech news outlets etc..
For the Agent Mode, we have actually developed a multi-agent framework. It first categorizes the user's query and then selects different agents based on these categories to address the issues. These various agents employ different models and solution steps.
Future Plans:
- Build a more comprehensive index that includes internal context (The Devv for Teams version will support indexing team repositories, documents, issue trackers for Q&A)
- Fully localized: All of the above technologies can be executed locally, ensuring privacy and security through complete localization.
Devv is still in its very early stages and can be used without logging in. We welcome everyone to experience it and provide feedback on any issues; we will continue to iterate on it.
[1]: https://arxiv.org/abs/2005.11401
Docsify is frequently updated; the latest release was on June 24, 2023, and the most recent update was on December 17, 2023. It is MIT-licensed and has an active Discord community.
ReDoc Interactive Demo
This post outlines the steps for migrating an existing BlogCFC blog to a JamStack, with a focus on using Eleventy.
Project mention: Can Git or any other VCS be used as a database instead of SQL/NoSQL ones? Have you ever seen such a thing? | /r/AskProgramming | 2023-12-07Arguably something like ikiwiki or gollum is doing this. These are both wikis that use git as their backend 'database'. I happen to like wikis like this a lot better over wikis that store their data in mysql or some other traditional SQL backend.
Case study 3: Zola
There's also Zeal (https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.
Sphinx is primarily known as a documentation generator, but it can also be used to create static websites. It excels in generating technical documentation, and its support for multiple output formats, including HTML and PDF, makes it a versatile tool. Sphinx uses reStructuredText for content creation and is highly extensible through plugins.
The Documentation Compendium
Project mention: Created a versus list for Note Taking Apps (last tab). What do you guys think? Did I miss anything? | /r/UpNote_App | 2023-07-04
Project mention: How to Write Impeccably Clean Code That Will Save Your Sanity | dev.to | 2023-07-27You can also use doc-strings to generate automated documentation for your code using a library like pdoc. Consider the following example from Stack-Scraper and the corresponding documentation generated using pdoc library.
NOTE:
The open source projects on this list are ordered by number of github stars.
The number of mentions indicates repo mentiontions in the last 12 Months or
since we started tracking (Dec 2020).
documentation-tool related posts
-
Converting BlogCFC blog to Eleventy
-
How to generate a great website and reference manual for your R package
-
Every Dunder Method in Python
-
Ask HN: What's the simplest static website generator?
-
Must-have for slacking off! 2024 Efficient Dev Tools for Increasing Productivity
-
Eleventy - Create a global production flag
-
VS Code - Fix a task automation issue - `The terminal process failed to launch (exit code: 127`
-
A note from our sponsor - SaaSHub
www.saashub.com | 10 May 2024
Index
What are some of the best open-source documentation-tool projects? This list will help you:
| Project | Stars | |
|---|---|---|
| 1 | Hugo | 72,657 |
| 2 | devdocs | 33,940 |
| 3 | docsify | 26,697 |
| 4 | redoc | 22,601 |
| 5 | eleventy 🕚⚡️ | 16,285 |
| 6 | Gollum | 13,565 |
| 7 | gutenberg | 12,743 |
| 8 | zeal | 11,083 |
| 9 | hugo-blox-builder | 7,819 |
| 10 | sphinx | 6,059 |
| 11 | documentation.js | 5,766 |
| 12 | The-Documentation-Compendium | 5,456 |
| 13 | nbdev | 4,755 |
| 14 | compodoc | 3,957 |
| 15 | Behat | 3,883 |
| 16 | BoostNote-App | 3,633 |
| 17 | tbls | 3,107 |
| 18 | codecrumbs | 2,687 |
| 19 | protoc-gen-doc | 2,566 |
| 20 | Documize | 2,072 |
| 21 | pdoc | 1,819 |
| 22 | graphdoc | 1,547 |
| 23 | awesome-magento2 | 1,106 |
Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com