markdoc
commonmark-spec
markdoc | commonmark-spec | |
---|---|---|
21 | 48 | |
7,006 | 4,835 | |
1.0% | 0.2% | |
5.8 | 6.9 | |
26 days ago | 3 months ago | |
TypeScript | Python | |
MIT License | GNU General Public License v3.0 or later |
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/
commonmark-spec
-
How to add a man page to your Ruby project, using kramdown-man and markdown
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. :(
-
How do you host documentation for your spouse or other users?
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.
-
On why Markdown is not a good, or even a half-decent, markup language
>A single canonical reference
https://commonmark.org/
-
Get ready for Bear 2 - We have a quick blog post with some important details and ways you can get notified once it's out!
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.
-
Best website to write a rulebook for ttrpgs
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.
- What is the most minimal, strictest variant of Markdown?
-
How to display an image
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.
-
Lightweight Markup for Ukrainian Texts?
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 `.
-
I wish Asciidoc was more popular
Check out commonmark, that is the Markdown standard supported by numerous converters including pandoc.
-
I wrote a markdown to html converter
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.
What are some alternatives?
mdx - Markdown for the component era
pandoc - Universal markup converter
MkDocs - Project documentation with Markdown.
kramdown - kramdown is a fast, pure Ruby Markdown superset converter, using a strict syntax definition and supporting several common extensions.
vue-markdoc - Vue renderer for Markdoc
marktext - 📝A simple and elegant markdown editor, available for Linux, macOS and Windows.
readme_renderer - Safely render long_description/README files in Warehouse
markdown-it-katex - Add Math to your Markdown with a KaTeX plugin for Markdown-it
next.js - Markdoc plugin for Next.js
Joplin - Joplin - the secure note taking and to-do app with synchronisation capabilities for Windows, macOS, Linux, Android and iOS.
vrite - Open-source developer content platform
rehype-sanitize - plugin to sanitize HTML