mkdocs-material
mdx
Our great sponsors
mkdocs-material | mdx | |
---|---|---|
92 | 99 | |
17,838 | 16,682 | |
- | 1.5% | |
9.8 | 8.7 | |
7 days ago | 4 days ago | |
HTML | 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.
mkdocs-material
-
The Open Source Sustainability Crisis
https://squidfunk.github.io/mkdocs-material/
I'm an 'outsider', but from from the outside the Material For MkDocs Project looks like a very well managed open source project.
Martin Donath's project uses a 'sponsorware' release strategy to generate donations.
From my vantage point it seems to be working pretty well.
- Agora a nossa Megathread possui um novo visual!
-
MdBook – Create book from Markdown files. Like Gitbook but implemented in Rust
Wow, what is up with the material mkdocs theme (https://squidfunk.github.io/mkdocs-material/)? That's an extremely spiffy landing page, especially given that it's for a theme designed for a totally separate piece of software.
- Koji projekat na Githubu vas je odusevio u zadnje vreme?
-
MkDocs Publisher as an alternative for official Obsidian publish.
I was considering Pelican at some stage, but MkDocs has a great mobile friendly theme (Material for MkDocs) that is part of the dependencies. This theme and my previous experience in using MkDocs, gave me a clear answer what to use. There were also some other MkDocs plugins, that I was considering to use before I started to develop my bundle, but they were lacking in some elements (like plugin for wikilinks not working correctly for Obsidian links and one for callouts with small problems in embedded callouts, etc.). Finally, I didn't use those plugins, but they were good source to take a look at the code and get some inspiration, etc. (most of those plugins will mentioned in documentation in credits section, that is under construction). If you will ever have some features requests, just create an issue in git repo of the project. I'm open to suggestions how to extend functionality ot this project.
-
Site-wide Protest, Introducing leagueoflinux.org, and Poll for What to do Next with r/leagueoflinux
The site is built using MkDocs and themed with MkDocs-Material. Being markdown-based, porting over the webpages from the subreddit wiki was fairly painless, and on some pages I've already been able to extend their capabilities with in-line images, buttons and more modern special formatting tools.
-
Anyone know of a free dev docs like confluence?
Maybe something like https://squidfunk.github.io/mkdocs-material/ or https://www.bookstackapp.com/ ?
-
Public API documentation. What to use?
I use a combo of swagger and mkdocks: https://squidfunk.github.io/mkdocs-material/
-
Ask HN: What is the best product documentation you’ve ever seen?
Visual Studio App Center has excellent documentation: https://learn.microsoft.com/en-us/appcenter/distribution/cod.... It's comprehensive and well structured.
If you're looking for a system that looks as good, mkdocs (https://www.mkdocs.org/) with the mkdocs-material theme (https://squidfunk.github.io/mkdocs-material/) can get you quite close!
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.
-
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.
- 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
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
Last, but certainly not least, among my favorite frameworks is the family of frameworks based on MDX. Before that, let’s understand what is MDX and how does it vary from MD.
-
Blogging with Next.js and MDX: The ultimate combination for dynamic content
Are you a developer looking to create a blog or personal website that is both easy to maintain and visually appealing? Look no further than using Next.js and MDX!
-
Contentlayer with next/image
My first reaction was to use MDX and use next/image just as in the example. But that means that we can't use normal markdown images and it turns out that this won't work with contentlayer. This wont work, because Next.js does some magic on the import of the static image. The object which gets returned by the import, contains not only a path to the image, it contains also the width and height, plus a very small version of the image for the blurred placeholder. This magic does not work if the MDX file is loaded with contentlayer, because contentlayer uses its own bundler, which does not know about the import magic for images.
What are some alternatives?
Docusaurus - Easy to maintain open source documentation websites.
sphinx - The Sphinx documentation generator
next-mdx-remote - Load mdx content from anywhere through getStaticProps in next.js
remark-gfm - remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
MkDocs - Project documentation with Markdown.
mkdocstrings - :blue_book: Automatic documentation from sources, for MkDocs.
Read the Docs - The source code that powers readthedocs.org
mike - Manage multiple versions of your MkDocs-powered documentation via Git
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
markdoc - A powerful, flexible, Markdown-based authoring framework.
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
emoji-shortcodes-for-markdown - 1000+ Emoji Finder app for Markdown, GitHub, Campfire, Slack, Discord and more...