next.js VS markdoc

Using Markdoc with Next.js

Released in 2022, Markdoc is a relatively new Markdown-based authoring framework. The Markdoc project is open-source and it powers Stripe's documentation. Their website has a live edit button which makes the website a playground for you to give Markdoc a try. Documentations created with Markdoc will automatically render with your React app and using @markdoc/next.js for your Next.js app.

A couple of weeks ago, we open-sourced Markdoc, the authoring tool powering the Stripe docs. To accompany the launch, we published a blog post showing how to get started using Markdoc with Next.js, using the @markdoc/next.js plugin. In this blog post, I’ll show you how to create your own plugin, using the one I wrote for Parcel, as an example, so that you can use Markdoc with it.

Official Markdoc documentation Markdoc repository Markdoc Next.js plugin repository Markdoc playground Next.js boilerplate demo

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/

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 .

Extension frameworks like Stripe’s, MarkDoc allows documentation to have code examples in multiple languages.

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.

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.

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.

Hola. Former Stripe employee here - they use Markdoc: https://markdoc.dev/