devportal
markdoc
Our great sponsors
devportal | markdoc | |
---|---|---|
3 | 21 | |
59 | 6,991 | |
- | 1.9% | |
9.5 | 5.8 | |
3 months ago | 17 days ago | |
PLpgSQL | TypeScript | |
Creative Commons Attribution 4.0 | 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.
devportal
-
Migrating to Docusaurus
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.
-
Markdown, Asciidoc, or reStructuredText - a tale of docs-as-code
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.
-
Automatically Open Pull Requests with GitHub Actions
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!
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/
What are some alternatives?
antora
mdx - Markdown for the component era
pandoc-action-example - using the pandoc document converter on GitHub Actions
MkDocs - Project documentation with Markdown.
markdown-live-preview - markdown editor with live preview
vue-markdoc - Vue renderer for Markdoc
Docusaurus - Easy to maintain open source documentation websites.
readme_renderer - Safely render long_description/README files in Warehouse
jekyll-multiple-languages-plugin - I18n support for Jekyll and Octopress
next.js - Markdoc plugin for Next.js
Vim - The official Vim repository
vrite - Open-source developer content platform