mkdocstrings
mdx
mkdocstrings | mdx | |
---|---|---|
9 | 99 | |
1,572 | 16,838 | |
2.5% | 0.9% | |
8.4 | 8.7 | |
9 days ago | 8 days ago | |
Python | JavaScript | |
ISC 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.
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.
mdx
-
How to Enhance Content with Semantify
Semantify was made for content creators, marketers, and anyone looking to enhance their long-form written content. Currently only supporting MDX-based content, It automates the enrichment of MDX blog posts by adding AI-generated Q&A sections that summarize the content, and recommendations for semantically similar posts. This not only makes the content more accessible and engaging but also helps in establishing deeper connections between different posts, ultimately keeping the reader engaged for longer periods.
- MDX – use JSX in your Markdown content
-
No CMS? Writing Our Blog in React
https://mdxjs.com/
> We thought this would be a no-brainer and that there would be some CMS/SSG libraries out there that made this Markdown conversion process easy and facilitated integration with any number of frontend frameworks.
You thought correct:
- NextJS MDX integration: https://nextjs.org/docs/pages/building-your-application/conf...
-
Introducing Content Collections
The example above uses react-markdown, but you can use any library you want to render the markdown content. You can also use a transform function to modify the markdown content during the build process. Here is an example that uses MDX to compile the markdown content.
-
Creating a static Next.js 14 Markdown Blog - An Adventure
MDX is a js library that allows us to import a markdown file as a react component and use it anywhere.
-
Building Stunning Docs: Diving Deep into Docusaurus Customization
/blog/ - This directory contains all the markdown files, of your site blogs, you can simply add a new blog by using markdown, or simply remove a blog file by deleting its file, you can combine the markdown with MDX, resulting a well-written blog post.
-
Show HN: Create email templates with Markdown and JSX
Hey HN!
This is a little personal project I've been hacking on for the past ~week, somewhat inspired by this blog post [0] ("My Wonderful HTML Email Workflow").
Basically I just wanted an easy way to create email templates in MDX [1] (Markdown + JSX), using React Email [2] components.
It's still a bit of a work in progress (and a bit slow at the moment) but wanted to share in case anyone else finds it interesting!
[0] https://www.joshwcomeau.com/react/wonderful-emails-with-mjml...
[1] https://mdxjs.com/
[2] https://react.email/
- Nota is a language for writing documents, like academic papers and blog posts
-
WYSIWYG for MDX?! Introducing Vrite's Hybrid Editor
That’s why formats like Markdown (MD) and MDX (MD with support for JSX) are so popular for use cases like documentation, knowledge bases, or technical blogs. They allow you to use any kind of custom formatting or elements and then process the content for publishing. On top of that, they’re great for implementing a docs-as-code approach, where your documentation lives right beside your code (i.e. in a Git repo).
-
Build a blog app with new Next.js 13 app folder and Contentlayer
MDX
What are some alternatives?
mkdocs-material - Documentation that simply works
next-mdx-remote - Load mdx content from anywhere through getStaticProps in next.js
sphinx - The Sphinx documentation generator
remark-gfm - remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
pydocstyle - docstring style checker
markdoc - A powerful, flexible, Markdown-based authoring framework.
furo - A clean customizable documentation theme for Sphinx
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
cookietemple - A collection of best practice cookiecutter templates for all domains and languages with extensive Github support ⛺
emoji-shortcodes-for-markdown - 1000+ Emoji Finder app for Markdown, GitHub, Campfire, Slack, Discord and more...
pydantic - Data validation using Python type hints
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.