|24 days ago||4 days ago|
|MIT License||MIT License|
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
Need help to find an coding documentation software
3 projects | reddit.com/r/selfhosted | 7 Jun 2021
You can get yours: https://github.com/chevere/docs-deploy (I know, it has some bits on Spanish. I made it for my team but I can translate it if people need to consume this).
Creating API documentation from php files?
4 projects | reddit.com/r/PHP | 3 Feb 2021
Here's the deploy repo https://github.com/chevere/docs-deploy
Stripe Open Sources Markdoc
19 projects | news.ycombinator.com | 11 May 2022
For anyone looking for a doc generation tool:
I was lately evaluating several tools like VuePress, Docusaurus and AsciiDoc.
I ended up using Mkdocs Material (https://squidfunk.github.io/mkdocs-material/). If you haven't already, have a look. I think it is pretty impressive. From tags, tabs to the fantastic built-in search ...19 projects | news.ycombinator.com | 11 May 2022
I recommend checking the list of OpenSource projects that use Material for MkDocs , for example FastAPI . Alternatively, you can clone the Material for MkDocs repository, as the docs are built with itself.
Ask HN: Is there a good framework for an interactive user manual?
3 projects | news.ycombinator.com | 28 Apr 2022
You end up with markdown split into logical folders, with a natural flow from each page to the next built in.
It’s built with python but you don’t need python knowledge at all to build; configure and serve the product.
The plug-in eco system adds the ability to embed variables into the markdown pages also you can embed html, so d3 visualisation or a vue calculator app will all embed just fine.
Really clean extensible base, insanely simple and fast to get started oh and free to use. I push mine to GitHub and have that auto build into GitHub pages or a free Netlify account.
Ask HN: Share Your Personal Site
87 projects | news.ycombinator.com | 6 Apr 2022
Next Level Readme
2 projects | reddit.com/r/opensource | 6 Apr 2022
For those that want to turn their markdown files into prettier HTML websites, there are tools like Material for MkDocs. Of course, this involves a lot more work and you’d need to host it on a separate site or enable GitHub Pages on the repo but it’s one way that I’ve found to keep the markdown files free of HTML.
New Encrypted DNS page
2 projects | reddit.com/r/PrivacyGuides | 31 Mar 2022
My favorite so far is https://squidfunk.github.io/mkdocs-material/
What devops tools should I implement from the start?
1 project | reddit.com/r/devops | 25 Mar 2022
Documentation, that should be the first thing you use. Documentation is the basis for all the things you do, it can be adapted and is implementation independent. If you want a framework to make it easy mkdocs material is nice.
Top 10 uncommon DevOps tools you should know
8 projects | dev.to | 24 Mar 2022
I love markdown, and MkDocs is my go-to tool for writing documentation, but it’s pretty bare. mkdocs-material is a template that you can put mkdocs on… except it packs a whole world of additional features: versioning your documentation, a native cookie consent solution, rich search previews, and a truckload of other things… seriously give the guy 10$ a month to get supporters-only features, and you’ll get the only documentation tool you will ever need. (for instance, the AWS Copilot CLI docs were written with this, see for yourself, that’s amazing).
mkdocs-material: Technical documentation that just works
1 project | reddit.com/r/u_TsukiZombina | 18 Mar 2022
Three DDoS attacks on my personal website
4 projects | reddit.com/r/homelab | 17 Mar 2022
What are some alternatives?
sphinx - Main repository for the Sphinx documentation builder
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
Read the Docs - The source code that powers readthedocs.org
mike - Manage multiple versions of your MkDocs-powered documentation via Git
Docusaurus - Easy to maintain open source documentation websites.
VuePress - 📝 Minimalistic Vue-powered static site generator
furo - A clean customizable documentation theme for Sphinx
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
fastapi - FastAPI framework, high performance, easy to learn, fast to code, ready for production
typedoc - Documentation generator for TypeScript projects.
docsify - 🃏 A magical documentation site generator.
MkDocs - Project documentation with Markdown.