nextra VS commonmark-spec

co-author here

we put in a lot of effort into our docs and we'd greatly appreciate any criticism or feedback! Langfuse is powerful but the docs should help beginners to quickly get started and then incrementally use more features.

docs are OSS, repo: https://github.com/langfuse/langfuse-docs

built using: https://github.com/shuding/nextra

However, this may just be due to the lack of proper documentation from the Nextra side of things (shoutout to Nextra though, regardless).

Nextra - Nextra is another option for creating documentation sites. While it might not be as well-known as Docusaurus, Nextra offers a modern and minimalist approach to building documentation. It is designed to be lightweight and user-friendly, making it a good choice for those who prefer a simple and clean documentation style. You can explore more about Nextra on their official website.

I have looked at https://nextra.site/ but that doesn't work with the app router yet. So I'm wondering if there's another alternative.

You could also have a look at Nextra. You can use mdx components to build your blog (including support for server-side fetching). I'm currently using their documentation template, but it seems they also have a blog template.

We write everything in Markdown, as it's the closest you'll get to a 'universal' format. Then, we use a static site generator to turn the docs into a website. Current projects are using Nextra for this. If you ever need to change site generators, you still have all the markdown docs and image files, so it's pretty easy to change.

https://nextra.site/ is nice

Today I found this tool for Next.js called Nextra. You can effortlessly create a blog post website or a documentation website. All you need is markdown. Simply export your markdown from Notion and utilize it with Nextra to enjoy all the cool features, including full-text search, syntax highlighting, dark/light mode, and even image support. Everything is generated at build time, making it a static website which is Blazingly fast. https://nextra.site/

Edit: this is because GitHub uses cmark-gfm, which is a fork of cmark, which implements the CommonMark variant of markdown. Looks like CommonMark still doesn't support definition lists. :(

BookStack dev here. There's no specific "import" option but you can use the Markdown editor in BookStack and paste in your Markdown content there. The API is essentially just an endpoint to accept the same kind of data, for of course you could automate against the API for batch import. One thing to keep in mind is that BookStack markdown support is fairly tightly scoped to (commonmark + tables + tasklists), although HTML within MD is supported.

>A single canonical reference

https://commonmark.org/

Typically with major new releases of software, when the number left of the dot (e.g. 2.0) increases, it’s shipped as a separate product. Not always, but generally. The Bear folks can speak for themselves but IIRC a lot of the code was refactored / rewritten to support, for example, CommonMark. So, under the hood, it’s literally brand new in some respects.

I use Obsidian (https://obsidian.md) for a lot of things, including my RPG stuff, and there are options for exporting things as PDFs. It’s great for getting organized and doing research, but I would use other tools for long-form writing and layout. What I like about Obsidian though is that everything is done in Markdown (https://commonmark.org) and I can use Pandoc (https://pandoc.org) to transform the source to whatever I need. The caveat is that Obsidian uses a flavor of Markdown with some non-standard extensions, so a pure Markdown editor like Typora (https://typora.io) might be a better choice depending on your needs.

yes, this is the "inventor" of markdown and those rules will always work. Hugo uses something called "Commonmark" which is developed on top of the original markdown. But the original rules will always work too.

Reddit and many other sites support Markdown as an easy way to add emphasis, links, headings, etc. Markdown does not contain any keywords, as it is intended to be language-independent. However, Markdown syntax makes heavy use of square brackets [] and other characters that are difficult to type with an Ukrainian keyboard layout, e.g., the backtick `.

Check out commonmark, that is the Markdown standard supported by numerous converters including pandoc.

And if this is an exercise into that you can use a Markdown spec like CommonMark which is the spec Reddit and a variety of other sites use.