stackedit
Read the Docs
Our great sponsors
stackedit | Read the Docs | |
---|---|---|
7 | 33 | |
21,256 | 7,842 | |
- | 0.4% | |
5.2 | 9.8 | |
9 months ago | 7 days ago | |
JavaScript | Python | |
Apache License 2.0 | 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.
stackedit
- Show HN: I've built open-source, collaborative, WYSIWYG Markdown editor
- I present to you: The textbook CEO
-
Write Plain Text Files
I mourn that StackEdit [1] got abandoned. It's online markdown editor that can use git as a backend. Fully cross platform editing (in browser) with synced all text. I used it with GitHub private repository for all my notes but editing on mobile was really buggy. So I moved to notion (unfortunately).
-
Gollum – A simple, Git-powered wiki with a sweet API and local frontend
I would love to have something like Notion but using git for all data storage and edit history.
There is https://stackedit.io/ offering it but I stopped using it because of bugs when trying to edit on mobile. And it basically abandoned for the last 2 years https://github.com/benweet/stackedit (only some deps updates, nothing more).
-
GhostWriter is a distraction free Markdown editor
Most dedicated markdown editors all end up using the same JS code editor components like Ace, CodeMirror or Monaco, and those editors have great vim keybindings usually as extensions or options. See if the tool you're using lets you flip those vim bindings on. For some editors they expose it as an option and for others you have to hack around with the source (for example enabling it with stackedit, a PWA markdown editor like ghostwriter, is possible with same hacking: https://github.com/benweet/stackedit/issues/254 ).
Read the Docs
-
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/
- Como criar e hospedar um site de documentação para o seu projeto usando Hugo e Netlify
-
Setting up a Documentation Website for your Software Project with Hugo and Netlify
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.
MdWiki
Hugo - The world’s fastest framework for building websites.
Wiki.js - Wiki.js | A modern and powerful wiki app built on Node.js
sphinx - The Sphinx documentation generator
Docusaurus - Easy to maintain open source documentation websites.
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.
Flatdoc - Build sites fast from Markdown
marktext - 📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
docsify - 🃏 A magical documentation site generator.