markdoc
mdx
Our great sponsors
markdoc | mdx | |
---|---|---|
21 | 99 | |
6,991 | 16,811 | |
1.9% | 1.6% | |
5.8 | 8.7 | |
17 days ago | 10 days ago | |
TypeScript | 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.
markdoc
- Markdoc – a flexible Markdown-based authoring framework built by Stripe
-
Ask HN: Stripe like API documentation tool?
Or please share any API documentation tools you use that is opensource and NOT Swagger.
Stripe has Markdoc[0] but it doesn't seem to be automated in any way.
[0]https://markdoc.dev/
- Nota is a language for writing documents, like academic papers and blog posts
-
Looking for a Knowledge-base Tool with SEO Optimization and Multimedia Support for my SaaS - Any Recommendations?
Try using https://markdoc.dev/ .. this is the documentation tool/editor by Stripe and it also powers the extensive documentation of the Stripe product itself .
- Show HN: I’m building open-source headless CMS for technical content
-
I read the full-GitHub-flavored markdown spec so you do not have to. GitHub natively supports many lesser known features including the ability to create diagrams, maps and even 3D models, directly from markdown text.
Extension frameworks like Stripe’s, MarkDoc allows documentation to have code examples in multiple languages.
-
Rust Is the Future of JavaScript Infrastructure
I'm bullish on Rust, but there's a long way still to go. The overhead of passing values across the boundary between JavaScript and Rust is quite high. There are a lot of cases where you want to be able to provide a dynamic configuration to Rust, ideally in JavaScript, and that's still pretty costly from a performance perspective.
One of my projects (https://markdoc.dev/) is a Markdown dialect that supports custom tags and a React renderer. I recently experimented with implementing a parser for it in Rust in order to increase performance. My Rust-based parser is significantly faster than my existing JavaScript parser, but then I have to serialize the AST in order to move it from Rust to JavaScript. I'd like to implement the entire processor in Rust, but I need to let users define custom tags in JavaScript, and the overhead of going back and forth is far from ideal.
I'm hopeful that the recently-ratified Wasm GC proposal—which introduces managed structs and arrays that don't cost anything to pass between the Wasm environment and JavaScript—will help a lot. But it's going to take awhile for Wasm GC features to land in LLVM and be properly supported in Rust.
-
Alternatives to Madcap?
Consider going down the docs-as-code route. There are open source options that require an investment of time for you to become familiar with the tech stack, so learn Markdown and Git if you haven't already. Stripe (who many consider to have some of the best documentation available) created Markdoc as a means of easily maintaining solid docs with some of the fancy quirks of the upper-end doc tools, including content re-use.
-
Use Markdoc and Next.js to Build a Git-powered Markdown Blog
Most modern developer blogs and documentation websites have one thing in common— they run on JAMstack (static websites) and their content is file-based and powered by Git. This allows multiple developers to collaboratively edit content with perks like versioning and version control. In this tutorial, we’re going to see how we can build a simple yet powerful and interactive blog with Next.js and Markdoc.
-
How to create documentation site
Hola. Former Stripe employee here - they use Markdoc: https://markdoc.dev/
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 - Project documentation with Markdown.
next-mdx-remote - Load mdx content from anywhere through getStaticProps in next.js
vue-markdoc - Vue renderer for Markdoc
remark-gfm - remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
readme_renderer - Safely render long_description/README files in Warehouse
astro - The web framework for content-driven websites. ⭐️ Star to support our work!
next.js - Markdoc plugin for Next.js
emoji-shortcodes-for-markdown - 1000+ Emoji Finder app for Markdown, GitHub, Campfire, Slack, Discord and more...
vrite - Open-source developer content platform
eleventy 🕚⚡️ - A simpler site generator. Transforms a directory of templates (of varying types) into HTML.
Docusaurus - Easy to maintain open source documentation websites.
pandoc - Universal markup converter