devportal VS mdx

Hello folks, I am running a tech writing team (along with product management). I am not expert in documentation platforms. Today we have a challenging custom-built documentation platform based on Sphinx and a bunch of cobbled together technologies aiven/devportal: Resources for users of the projects on the Aiven platform (github.com) . Our documentation is in .rst markup language due to the Python focus.

Humble brag that the last one in the list (Aiven 🦀) won 2022 DevPortal Awards in the category Best DevPortal Beyond REST Platforms. If I added a list of great docs websites but didn't include the OG, it would be a crime. Check out one of THE BEST documentation out there - Stripe Docs, built using Markdoc.

You can find a list of Aiven's cloud providers on [Developer.aiven.io], which is also the portal where we host the developer documentation. To quickly retrieve a list of currently-available cloud providers, my colleague Lorna Mitchell wrote a Python script that pulls our cloud listing from the Aiven API and generates documentation, which is really cool!

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.

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...

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.

MDX is a js library that allows us to import a markdown file as a react component and use it anywhere.

/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.

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/

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).

MDX