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. 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.
-
-
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
Project mention: The-art-of-command-line: Master the command line, in one page | news.ycombinator.com | 2024-02-19
[Bug]: Configuration with TailwindCss Next.js using Tailwind with Storybook
Mermaid - 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
> I've started to preface all python searches with 'site:python.org'
You might find DevDocs to be useful: https://devdocs.io/
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.
Material Mk-Docs by Martin Donath works well if you prefer python.
Project mention: I'm making a GlowUI text editor to get back into coding | /r/Windows11 | 2023-06-09If you need a WYSIWYG markdown editor you can try Toast UI Editor or simply use Markdown Live add-on for Visual Studio Code
I wholeheartedly agree. At most, I introduce JSDoc[1] to newer developers as standardising how parameters and whatnot are commented at least gets you better documentation and _some_ safety without adding any TS knowledge overhead.
[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.
react-styleguidist
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
- ELT as Compliance Enabler: Running Steampipe with Matillion Data Productivity Cloud
- Creating Animated Diagrams for LinkedIn
- The origin and virtues of semicolons in programming languages
- Doceaser: Interactive documentation with Markdown and Htmx made easier
- Here are the 10 projects I am contributing to over the next 6 months. Share yours
- ChatCraft Adventures #13, UI Changes
- Why does part of the Windows 98 Setup program look older than the rest?
-
A note from our sponsor - InfluxDB
www.influxdata.com | 26 Apr 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,541 |
| 2 | storybook | 82,810 |
| 3 | mermaid | 66,838 |
| 4 | Docusaurus | 52,824 |
| 5 | tldr | 48,406 |
| 6 | professional-programming | 45,235 |
| 7 | cheat.sh | 37,443 |
| 8 | wtfpython | 35,051 |
| 9 | devdocs | 33,858 |
| 10 | docsify | 26,611 |
| 11 | gitbook | 26,337 |
| 12 | docz | 23,494 |
| 13 | Wiki.js | 23,451 |
| 14 | MkDocs | 18,257 |
| 15 | mkdocs-material | 18,198 |
| 16 | TOAST UI Editor | 16,759 |
| 17 | JSDoc | 14,742 |
| 18 | BookStack | 13,833 |
| 19 | editor.md | 13,562 |
| 20 | Gollum | 13,559 |
| 21 | cheat | 11,940 |
| 22 | zeal | 11,052 |
| 23 | react-styleguidist | 10,788 |
Sponsored
The modern identity platform for B2B SaaS
The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
workos.com