Our great sponsors
|MdWiki||Read the Docs|
|-||6 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.
We haven't tracked posts mentioning MdWiki yet.
Tracking mentions began in Dec 2020.
Read the Docs
Exploring Django's Third-Party Packages: Top Libraries You Should Know
8 projects | dev.to | 8 Jul 2023
ReadTheDocs - ReadTheDocs hosts documentation for many Django packages. It provides easy access to comprehensive documentation, including installation instructions, configuration guides, and usage examples.
ReadTheDocs Sphinx theme urllib3 related build errors
2 projects | /r/technicalwriting | 5 May 2023
fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290
Dealing with documentation
4 projects | /r/ProgrammingLanguages | 23 Apr 2023
Read the Docs offers free hosting of Sphinx-based documentation. I recommend setting up a basic documentation very early so that you can easily add material when you have something to write about. I also recommend studying The Grand Unified Theory of Documentation, but don't overthink it.
Document or Die: The Importance of Writing Things Down in Tech
2 projects | dev.to | 10 Apr 2023
ReadTheDocs: An open-source platform for creating and hosting documentation, with support for multiple programming languages and integration with version control systems.
datadelivery: Providing public datasets to explore in AWS
5 projects | dev.to | 8 Apr 2023
Well, by now I really invite all the readers to join and read more about the datadelivery Terraform module. There is a huge documentation page hosted on readthedocs with many useful information about how this project can help users on their analytics journey in AWS.
Marketing for Developers
7 projects | dev.to | 26 Feb 2023
ReadTheDocs is a free way to host your open-source documentation.
Re-License Vaultwarden to AGPLv3
5 projects | news.ycombinator.com | 12 Feb 2023
They are using this infrastructure as the moat. ReadTheDocs is also doing the same thing.
Deploy if you dare: https://github.com/readthedocs/readthedocs.org
Yahoo is making a return to search
5 projects | news.ycombinator.com | 30 Jan 2023
That "/*/tree" rule means that search engine crawlers are allowed to hit the README file of a repo but effectively NONE of the other files in it.
Which means that if you keep your project documentation on GitHub in a docs/ folder it won't be indexed!
You need to publish it to a separate site via GitHub Pages, or use https://readthedocs.org/
Como criar e hospedar um site de documentação para o seu projeto usando Hugo e Netlify
3 projects | dev.to | 12 Jan 2023
Setting up a Documentation Website for your Software Project with Hugo and Netlify
5 projects | dev.to | 10 Jan 2023
Readthedocs + mkdocs: this is a good combination using the free documentation platform Readthedocs. You get a free .readthedocs subdomain, and can also set up a custom domain. I use it for the Minicli docs, overall a good solution but I find it to be a bit flaky sometimes, specially when there are updates.
What are some alternatives?
MkDocs - Project documentation with Markdown.
mkdocs-material - Documentation that simply works
just-the-docs - A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
Hugo - The world’s fastest framework for building websites.
sphinx - The Sphinx documentation generator
Docusaurus - Easy to maintain open source documentation websites.
Gollum - A simple, Git-powered wiki with a sweet API and local frontend.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
daux.io - Daux.io is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
Dokuwiki - The DokuWiki Open Source Wiki Engine
Flatdoc - Build sites fast from Markdown