Build cloud backends with Infrastructure-from-Code (IfC), a revolutionary technique for generating and updating cloud infrastructure. Try IfC with AWS and Klotho now (Now open-source) Learn more →
Top 23 Documentation Open-Source Projects
-
The Art of Command Line — notes and tips on using the command-line, suitable for both beginners and experienced users
-
storybook
Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.
I'll be the third here to say it, but with a link: Storybook
-
Appwrite
Appwrite - The Open Source Firebase alternative introduces iOS support . Appwrite is an open source backend server that helps you build native iOS applications much faster with realtime APIs for authentication, databases, files storage, cloud functions and much more!
-
mermaid
Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdown
MermaidJS
-
My company uses Confluence, but if moving on there will be a greenfield project coming along. Maybe Docusaurus https://docusaurus.io/ is an ideal situation. Markdown FTW
-
Project mention: Was looking at the GitHub page for eg and found this gem | /r/commandline | 2023-05-31
-
I like what you're doing with this, never used cheat.sh before but had a little look around and great idea :) I've not tested everything, i seen something about find and thought i could help.
-
Haven’t seen it mentioned in the replies, so here it is. Have a look at “What the f*ck Python? 😱” on GitHub: https://github.com/satwikkansal/wtfpython
-
Klotho
AWS Cloud-aware infrastructure-from-code toolbox [NEW]. Build cloud backends with Infrastructure-from-Code (IfC), a revolutionary technique for generating and updating cloud infrastructure. Try IfC with AWS and Klotho now (Now open-source)
-
Project mention: Zeal is an offline documentation browser for software developers | news.ycombinator.com | 2023-05-31
-
-
Project mention: Ask HN: Any Sugestions for Proceures Documentation? | news.ycombinator.com | 2023-02-15
The tools to author it aren't that important, frankly. Ask your audience what they're most comfortable using and try to meet them there.
If the stakeholders are technical, you have more options. If they aren't, I hope you like Google Docs or Word, because if you give them anything other than that or a PDF, they'll probably complain. At worst, yeah, write it in a long Markdown text file and use tools like pandoc to transform that into other formats as needed.
If you do need a website and you're not generating enterprise-scale amounts of content (and it sounds like you're not) try things that let you avoid needing build steps and infrastructure if at all possible, so you can iterate and deploy changes with as little friction as you can.
Tools like Docsify[1] can take a pile of Markdown files and serve a site out of them, client- or server-side, without a static build step. Depending on the org, you can get away with GitHub's default rendering of Markdown in a repo. Most static site builds for stuff your scale are overengineered instances of premature optimization.
Past those initial hurdles, the format and tools challenges are all in maintenance. How can you:
- most easily keep the content up to date
- delegate updates as the staff grows or changes
- proactively distribute updates ASAP to the people who'd most benefit from receiving them
That's going to depend a lot more on who'll contribute updates, what their technical proficiency's like, and how they prefer to communicate. It might be a shared git repo and RSS or Slack notifications if they're comfortable with those things, and it might be a Google Doc and email if they're like most non-technical stakeholders.
-
Also this repo helps https://github.com/charlax/professional-programming
-
This is a real concern. I've worked on some Yarn projects where I sometimes forget and accidentally run npm. Although these package managers (I'll call them PMs for short) are interoperable to some degree, there are important differences between these tools, so you should know what you're getting into. Even in seemingly simple projects, results can vary. Here are two reports of things working with one PM, but not another. Moreso, running install once is very different from continuous concurrent use, where you're adding and removing packages and more.
-
-
Project mention: Ask HN: What is the best product documentation you’ve ever seen? | news.ycombinator.com | 2023-05-06
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
-
- Toast UI Editor: https://ui.toast.com/tui-editor
-
electron-vue
An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.
Address: https://github.com/SimulatedGREG/electron-vue
-
I use a combo of swagger and mkdocks: https://squidfunk.github.io/mkdocs-material/
-
I use JSDoc annotations, and jsdoc package to auto-generate MarkDown and HTML documentation. I use it for [this website](zuixjs.org/). It's open source.
-
Django-mdeditor is Markdown Editor plugin application for django base on Editor.md.
-
samo haotični tekst fajlovi za svoje beleške, a za one koje trebaju i drugi da čitaju onda markdown da bude ipak malo uređeno. A generalno za dokumentaciju bookstack
-
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.
Project mention: Was looking at the GitHub page for eg and found this gem | /r/commandline | 2023-05-31I tried eg and tldr, but I preferred cheat. Why, and why not. Cheat not only have nice examples, but let you improve them or create yours. I use the cli, not the curl.
-
React Styleguidist is a tool that generates a living style guide for React components. This tool helps developers to document and showcase their components, making it easier for other developers to understand and use them. You can visit its official website to learn more: https://react-styleguidist.js.org/.
-
Project mention: Zeal is an offline documentation browser for software developers | news.ycombinator.com | 2023-05-31
It’s not widely advertised (probably this is the deal) but Zeal works fine on macOS, see this: https://github.com/zealdocs/zeal/wiki/Build-Instructions-for...
You don’t need to build it yourself, there is a brew formula.
-
InfluxDB
Access the most powerful time series database as a service. Ingest, store, & analyze all types of time series data in a fully-managed, purpose-built database. Keep data forever with low-cost storage and superior data compression.
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).
The latest post mention was on 2023-06-03.
Documentation related posts
- [TechStory]: Migrating services and databases from an OpenShift (or K8s) cluster to another
- Polkadot Forum - Advanced Level Discussion
- Why is the FAT directory creation time 24 bits and not 16 bits like the modified time?
- Was looking at the GitHub page for eg and found this gem
- Python LSP setups for productive coding
- Issues routing a container through another vpncontainer
- Good godot tutorial?
-
A note from our sponsor - Klotho
klo.dev | 3 Jun 2023
Index
What are some of the best open-source Documentation projects? This list will help you:
| Project | Stars | |
|---|---|---|
| 1 | the-art-of-command-line | 136,642 |
| 2 | storybook | 78,931 |
| 3 | mermaid | 57,907 |
| 4 | Docusaurus | 45,051 |
| 5 | tldr | 44,355 |
| 6 | cheat.sh | 35,359 |
| 7 | wtfpython | 32,709 |
| 8 | devdocs | 31,522 |
| 9 | gitbook | 25,596 |
| 10 | docsify | 23,573 |
| 11 | professional-programming | 23,433 |
| 12 | docz | 23,270 |
| 13 | Wiki.js | 21,031 |
| 14 | MkDocs | 16,485 |
| 15 | TOAST UI Editor | 15,988 |
| 16 | electron-vue | 15,257 |
| 17 | mkdocs-material | 14,052 |
| 18 | JSDoc | 13,860 |
| 19 | editor.md | 13,002 |
| 20 | BookStack | 11,626 |
| 21 | cheat | 10,797 |
| 22 | react-styleguidist | 10,652 |
| 23 | zeal | 10,354 |
Write Clean JavaScript Code. Always.
Sonar helps you commit clean code every time. With over 300 unique rules to find JavaScript bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.
www.sonarsource.com