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
Master the command line, in one pageProject mention: Linux Command Line Cheat Sheet: All the Commands You Need | /r/linux | 2023-04-06
The Art of Command Line — notes and tips on using the command-line, suitable for both beginners and experienced users
Storybook is a frontend workshop for building UI components and pages in isolation. Made for UI development, testing, and documentation.Project mention: Documenting recommended use of basic components | /r/reactjs | 2023-06-03
I'll be the third here to say it, but with a link: Storybook
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!
Generation of diagrams like flowcharts or sequence diagrams from text in a similar manner as markdownProject mention: Which tools do you use to create diagrams? | /r/golang | 2023-04-18
Easy to maintain open source documentation websites.Project mention: What are some harsh truths that r/devops needs to hear? | /r/devops | 2023-05-20
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
📚 Collaborative cheatsheets for console commandsProject mention: Was looking at the GitHub page for eg and found this gem | /r/commandline | 2023-05-31
the only cheat sheet you needProject mention: ? - The only cheat sheet you need | /r/bash | 2023-06-02
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.
What the f*ck Python? 😱Project mention: Multidimensional lists creation, why the weird behavior | /r/Python | 2023-04-22
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
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)
API Documentation BrowserProject mention: Zeal is an offline documentation browser for software developers | news.ycombinator.com | 2023-05-31
📝 Modern documentation format and toolchain using Git and MarkdownProject mention: Any tool for eBook web self-publishing? | /r/selfhosted | 2023-03-08
🃏 A magical documentation site generator.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 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.
A collection of learning resources for curious software engineersProject mention: How long did it take you to code by second nature? | /r/Python | 2023-04-26
Also this repo helps https://github.com/charlax/professional-programming
✍ It has never been so easy to document your things!Project mention: Why aren't Node.js package managers interoperable? | dev.to | 2022-10-07
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.
Wiki.js | A modern and powerful wiki app built on Node.jsProject mention: Selbstgehostetes Wiki mit "Querverweisen"? | /r/de_EDV | 2023-05-23
Project documentation with Markdown.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
🍞📝 Markdown WYSIWYG Editor. GFM Standard + Chart & UML Extensible.Project mention: Is there a way to edit callouts in preview mode | /r/ObsidianMD | 2023-01-30
- Toast UI Editor: https://ui.toast.com/tui-editor
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.Project mention: How to Use MQTT in The Electron Project | dev.to | 2022-06-19
Documentation that simply worksProject mention: Public API documentation. What to use? | /r/golang | 2023-05-18
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.
The open source embeddable online markdown editor (component).Project mention: Integrating Django Admin with Markdown Editor | dev.to | 2022-09-15
Django-mdeditor is Markdown Editor plugin application for django base on Editor.md.
A platform to create documentation/wiki content built with PHP & LaravelProject mention: Imate li knowledge base, second brain? | /r/programiranje | 2023-06-02
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 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-31
I 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.
Isolated React component development environment with a living style guideProject mention: 7 best ReactJS developer tools to simplify your workflow | dev.to | 2023-02-23
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/.
Offline documentation browser inspired by DashProject 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.
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.
Documentation related posts
[TechStory]: Migrating services and databases from an OpenShift (or K8s) cluster to another
3 projects | dev.to | 3 Jun 2023
Polkadot Forum - Advanced Level Discussion
3 projects | /r/polkadot_market | 3 Jun 2023
Why is the FAT directory creation time 24 bits and not 16 bits like the modified time?
1 project | /r/techsupport | 2 Jun 2023
Was looking at the GitHub page for eg and found this gem
3 projects | /r/commandline | 31 May 2023
Python LSP setups for productive coding
1 project | /r/HelixEditor | 1 Jun 2023
Issues routing a container through another vpncontainer
1 project | /r/unRAID | 1 Jun 2023
Good godot tutorial?
1 project | /r/godot | 31 May 2023
A note from our sponsor - Klotho
klo.dev | 3 Jun 2023
What are some of the best open-source Documentation projects? This list will help you:
|15||TOAST UI Editor||15,988|