mkdocstrings
HedgeDoc
mkdocstrings | HedgeDoc | |
---|---|---|
9 | 48 | |
1,579 | 4,710 | |
2.5% | 2.1% | |
8.4 | 9.8 | |
1 day ago | 1 day ago | |
Python | TypeScript | |
ISC License | GNU Affero General Public License v3.0 |
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.
mkdocstrings
-
Starlite development updates January ’23
Mkdocs has the mkdocstrings plugin, offering limited automated API documentation capabilities. It is however nowhere near as capable as Sphinx' autodoc, missing granularity in its configuration, limited intersphinx-like cross-referencing support, and essential features like documentation of inherited members, or the ability to manually describe objects if needed.
-
what's a good documentation platform that you guys would recommend?
mkdocstrings works well, although it is not as powerful as the API documentation in Sphinx.
-
Stripe Open Sources Markdoc
Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.
[1]: https://mkdocstrings.github.io/
- Mkdocstrings: Automatic Python documentation from sources, for MkDocs
- Technical documentation that just works
-
mkdocstrings: the "autodoc" plugin for MkDocs
Some time has passed since I first introduced mkdocstrings here on reddit. If you don't know what mkdocstrings is: it's the equivalent of the autodoc Sphinx extension, but for MkDocs, a Markdown static site generator. It works differently though, and supports multiple languages by design (not only Python). Someone actually wrote a very good handler for the Crystal language, and another user on GitHub recently expressed their interest for writing one for Go.
-
Python tutorials building large(r) projects
Write proper docstrings as you go along (every time you write a new class/method/function you can document what it’s doing as you’ll know why and what from the pattern you chose). Using a tool like mkdocstrings makes maintaining documentation for larger projects automatic.
-
[Project] mkgendocs - Generating documentation from Python docstrings for MkDocs
I learned of https://github.com/pawamoy/mkdocstrings recently. Is it similar ?
-
Python packages and plugins as namespace packages
A user of mkdocstrings wrote a Crystal handler for their own use-case. They asked on the Gitter channel if we could allow to load external handlers, so they don't have to fork the project and install the fork, but rather just install their lightweight package containing just the handler.
HedgeDoc
-
Building a Blog in Django
Nice and simple. I feel the only lacking feature for a basic blog is having unlisted blog posts, which is very handy when you want to share it to proof-readers. This can be done on google doc/hedgedoc [0] for sure, but then when porting there are very often typos creeping in.
[0] https://hedgedoc.org/
- HedgeDoc is a collaborative Markdown editor
-
Looking for a note taking app with inline tags.
Maybe Hedgedoc will fit these needs? You can use markdown to format. https://hedgedoc.org/
-
Note taking app with collaboration (may be not real time)
If self-hosting is an option for you I would recommend that you go with HedgeDoc. Completely open source, you get all the features you asked for including real time collaboration.
-
Google CEO Sundar Pichai Received $226M Compensation While Firing Thousands
You can give HedgeDoc (https://hedgedoc.org/) a try as a replacement for Google Docs.
It is the one that works best for concurrent editing IMO (but it is markdown which can be a problem for some)
-
Alternative to Google Keep?
I use one singular HedgeDoc document for that purpose. It's not exactly the same intent as Google Keep, but it's an awesome project I use anyway and fills the role perfectly for me personally.
-
IT Pro Tuesday #245 - Collaboration Tool, Automation Blog, Flow Collector & More
HedgeDoc is a web-based, self-hosted, collaborative markdown editor. This open-source option allows a team to easily share ideas on notes, graphs and presentations in real-time. troubleshootmertr finds it a good option "for knowledgebase."
- Class Note taking for courses
-
Marp: Markdown Presentation Ecosystem
HedgeDoc [0] allows you to collaborate in markdown, and also create slides.
[0] https://hedgedoc.org/ and https://demo.hedgedoc.org/slide-example?both
-
Just finished migrating my old tower servers to a Kubernetes cluster on my new rack!
For writing Markdown documents I use Hedgedoc.
What are some alternatives?
mkdocs-material - Documentation that simply works
HackMD - CodiMD - Realtime collaborative markdown notes on all platforms.
sphinx - The Sphinx documentation generator
Joplin - Joplin - the secure note taking and to-do app with synchronisation capabilities for Windows, macOS, Linux, Android and iOS.
pydocstyle - docstring style checker
Etherpad - Etherpad: A modern really-real-time collaborative document editor.
furo - A clean customizable documentation theme for Sphinx
Trilium Notes - Build your personal knowledge base with Trilium Notes
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
CryptPad - Collaborative office suite, end-to-end encrypted and open-source.
pydantic - Data validation using Python type hints
Planka - The realtime kanban board for workgroups built with React and Redux.