SaaSHub helps you find the best software and product alternatives Learn more →
Top 23 Documentation Open-Source Projects
-
storybook
Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
-
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.
-
mermaid
Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
-
-
-
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.
-
-
-
-
-
-
-
-
-
-
Gollum
A simple, Git-powered wiki with a local frontend and support for many kinds of markup and content.
-
cheat
cheat allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.
-
-
-
SaaSHub
SaaSHub - Software Alternatives and Reviews. SaaSHub helps you find the best software and product alternatives
As a development server, we can use an actual development server of our app, like Create React App (that we use for the examples) or Vite, or another tool like React Styleguidist or Storybook, to test isolated components.
Project mention: Show HN: Collaborative, text-based technical diagramming tool | news.ycombinator.com | 2024-05-08There is no documentation of the syntax. How is this different from MermaidJS[1]?
[1]https://mermaid.js.org/#/
Docusaurus is a popular open-source documentation tool primarily designed for product documentation and other technical documentation needs. It was first released in 2017 by Facebook Open Source (now Meta Open Source). Just recently, Docsaurus version 3.0 was released.
Maybe this already helps: https://github.com/tldr-pages/tldr
Project mention: A collection of learning resources for curious software engineers | news.ycombinator.com | 2024-02-19The inclusion of the perspective section: https://github.com/charlax/professional-programming?tab=read... I think is really smart. Same for personal productivity. Two things that can dramatically change how and what you end up studying and doing with your time / life.
I did a coding bootcamp and yeah the frontend knowledge they taught was useful, but I could have learned that online for free. Looking back, the far more valuable thing I learned was how to discipline myself and my time - that was the first time in my life I was truly disciplined and mindful in how I spent my time. I also got perspective I'd never seen before: there was some folks in my cohort that were in their 30s and 40s and undergoing career change, and I learned two things from them: First, don't stress too much, your life has much more flexibility than you might expect (this truth is borne out, they all have perfectly successful careers in their new lives as engineers), and second, make a great use of the time you have.
Bog-standard advice we all know, but to witness it firsthand from people living it and sharing it is different. The shared article in the github is incredible: https://www.theguardian.com/commentisfree/2020/sep/07/termin...
I often wonder why I don't see more of these sorts of articles. From watching a family member slowly die of cancer, and from reading books like "When Breath Becomes Air," I'm guessing it's some combination of exhaustion, disability, and a new set of priorities that doesn't really involve death blogging. Still, I find these kinds of writings more poignant than most things I read.
curl https://cheat.sh/$1
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.
GitBook is a well-known online platform for developing, sharing, and publishing technical documentation. Although it’s not open source, it offers free and paid plans, with the free plan having limited features and functionalities. The paid plans unlock more features, such as custom domains, team collaboration, and advanced analytics.
Wiki.js is a self hosted, open source Wiki that has a lot of awesome functionality. Unfortunately it's lacking some small, but important UI features, like a light box, to enlarge downsized images to it's full size. And unless you want to add a link to each image, to open it in a new tab, you would probably go for a modal view here.
8
A step in that direction can be seen in TOAST UI editor:
You may like JSDoc[1] if you just want some type-safety from the IDE without the compilation overhead.
It’s done wonders when I’ve had to wrangle poorly commented legacy JavaScript codebases where most of the overhead is tracing what type the input parameters are.
Personally, I’m impartial to TypeScript or JSDoc at this point. But I’d rather have either over plain JavaScript.
[1] https://jsdoc.app/
Project mention: 15 open-source tools to elevate your software design workflow | dev.to | 2024-01-22Link | Demo | Github | License
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.
Looks like bro pages is archived and they recommend https://github.com/tldr-pages/tldr or https://github.com/cheat/cheat
There's also Zeal (https://zealdocs.org/) which is basically the same as Dash but open source and runs on non-Mac devices.
As a development server, we can use an actual development server of our app, like Create React App (that we use for the examples) or Vite, or another tool like React Styleguidist or Storybook, to test isolated components.
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 related posts
-
Show HN: I made a better Perplexity for developers
-
Show HN: Collaborative, text-based technical diagramming tool
-
The Art of Command Line
-
Modern React testing, part 5: Playwright
-
Figma's Journey to TypeScript
-
AsciidocFX: The Asciidoc Editor for documentation and authoring
-
Everything Curl
-
A note from our sponsor - SaaSHub
www.saashub.com | 8 May 2024
Index
What are some of the best open-source Documentation projects? This list will help you:
| Project | Stars | |
|---|---|---|
| 1 | the-art-of-command-line | 148,953 |
| 2 | storybook | 82,881 |
| 3 | mermaid | 67,199 |
| 4 | Docusaurus | 52,968 |
| 5 | tldr | 48,494 |
| 6 | professional-programming | 45,308 |
| 7 | cheat.sh | 37,506 |
| 8 | wtfpython | 35,081 |
| 9 | devdocs | 33,940 |
| 10 | docsify | 26,658 |
| 11 | gitbook | 26,392 |
| 12 | Wiki.js | 23,557 |
| 13 | docz | 23,507 |
| 14 | mkdocs-material | 18,342 |
| 15 | MkDocs | 18,330 |
| 16 | TOAST UI Editor | 16,774 |
| 17 | JSDoc | 14,762 |
| 18 | BookStack | 13,869 |
| 19 | editor.md | 13,584 |
| 20 | Gollum | 13,563 |
| 21 | cheat | 11,973 |
| 22 | zeal | 11,083 |
| 23 | react-styleguidist | 10,792 |
Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com