Read the Docs
docsify
Our great sponsors
Read the Docs | docsify | |
---|---|---|
33 | 29 | |
7,870 | 26,611 | |
0.4% | 1.4% | |
9.7 | 8.2 | |
7 days ago | 3 days ago | |
Python | JavaScript | |
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.
Read the Docs
-
Ask HN: ReadTheDocs Became Proprietary Now?
I went to https://readthedocs.org/ and redirected me to https://about.readthedocs.com/?ref=readthedocs.org which looks proprietary now, with pricing and such.
Is it the end of this project, as we know it?
Can someone enlighten me please?
-
Quick Guide to Leveraging Read the Docs for Your GitHub Projects
First things first, sign up on Read the Docs and connect your GitHub account. This allows Read the Docs to access your repositories.
-
Exploring Django's Third-Party Packages: Top Libraries You Should Know
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
fixes are here: https://github.com/readthedocs/readthedocs.org/issues/10290
-
Dealing with documentation
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
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
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
ReadTheDocs is a free way to host your open-source documentation.
-
Re-License Vaultwarden to AGPLv3
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
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/
docsify
-
Alternatives to Docusaurus for product documentation
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.
-
Cookbook for SH-Beginners. Any interest? (building one)
okay new plan, does anyone know how to do this docsify on github? i obviously am a noob on github and recently on reddit. I'd like to help where i can but my knowlegde seems to be my handycap. i could provide you a trash-mail, if you need one, but i need a PO (product owner) to manage the git... i have no clue about this yet (pages and functions and stuff)
-
Ask HN: Any Sugestions for Proceures Documentation?
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.
1: https://docsify.js.org
- Docsify.js single-page apps are indexable on Google!
- Library / CMS / framework for documentation?
-
How to Build a Personal Webpage from Scratch (In 2022)
Big fan of https://docsify.js.org since theres no need to compile your static site. A small amount of js just renders markdown.
-
Example of Support Guide for End Users
If you are searching for examples of an arbitrary Jellyfin support site, visit https://travisflix.com/help/#/support (or help.travisflix.com which redirects to the /help/ URI of the TLD) to take a look at what I have done with docsify on Github Pages.
- Show HN: Markdown as Web Page/Site
-
Phabricator replacement? | Or OpenProject alternative? | issue tracking/code
*Leantime - Competitor to OP? Updated recently, uses Docsify, no demo :(
-
I'm a co-founder of an IT agency, and I need help with new ideas.
There are a lot of open-source projects that can help businesses to save time and money. For example, we created a Free Admin panel a few months ago https://github.com/altence/lightence-admin That's an example of free documentation generator https://github.com/docsifyjs/docsify There are a lot more examples. And I want to find an idea of some similar generic solutions that can help various types of businesses
What are some alternatives?
MkDocs - Project documentation with Markdown.
Docusaurus - Easy to maintain open source documentation websites.
mkdocs-material - Documentation that simply works
VuePress - ๐ Minimalistic Vue-powered static site generator
just-the-docs - A modern, high customizable, responsive Jekyll theme for documentation with built-in search.
front-matter - Extract YAML front matter from strings
MdWiki
Hugo - The worldโs fastest framework for building websites.
BookStack - A platform to create documentation/wiki content built with PHP & Laravel
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
typedoc - Documentation generator for TypeScript projects.