Stripe Open Sources Markdoc

This page summarizes the projects mentioned and recommended in the original post on news.ycombinator.com

Our great sponsors
  • InfluxDB - Build time-series-based applications quickly and at scale.
  • Sonar - Write Clean JavaScript Code. Always.
  • Zigi - The context switching struggle is real
  • Scout APM - Truly a developer’s best friend
  • docs

    Documentation site for Markdoc (by markdoc)

    One curiosity: I was trying to figure out how the diagram at the top of https://markdoc.io/docs/render was generated.

    The items inside the diagram seem curiously absent from the source of the page: https://raw.githubusercontent.com/markdoc/docs/main/pages/do...

    Instead, when the `diagram` tag is defined, it maps the "type" parameter to a particular diagram: https://github.com/markdoc/docs/blob/main/components/Diagram...

    Any reason it is done that way, rather than specifying the diagram in the source of the document using mermaid, pikchr, etc?

  • mkdocs-material

    Documentation that simply works

    For anyone looking for a doc generation tool:

    I was lately evaluating several tools like VuePress, Docusaurus and AsciiDoc.

    I ended up using Mkdocs Material (https://squidfunk.github.io/mkdocs-material/). If you haven't already, have a look. I think it is pretty impressive. From tags, tabs to the fantastic built-in search ...

  • InfluxDB

    Build time-series-based applications quickly and at scale.. InfluxDB is the Time Series Data Platform where developers build real-time applications for analytics, IoT and cloud-native services in less time with less code.

  • docs

    Source code for the Streamlit Python library documentation (by streamlit)

    I don't understand how this is fundamentally different than MDX, which can already mix React components within Markdown.

    We used it to build the Streamlit docs. I assumed this is how everyone was doing documentation: https://github.com/streamlit/docs

  • mdx

    Markdown for the component era

    I haven't heard of MDX before, but this looks fantastic. The API looks more intuitive than Markdoc. https://mdxjs.com/ for anyone else wanting to learn more.

  • markdoc

    A literate programming package for Stata which develops dynamic documents, slides, and help files in various formats (by haghish)

  • Docusaurus

    Easy to maintain open source documentation websites.

    mdx is great, especially if your team is already fluent with react/jsx. You might also be interested in docusaurus https://docusaurus.io/ as it has support for mdx built in.

  • instaunit

    A tool for testing and documenting Web APIs

    Shameless plug: for REST APIs, I've written a tool called Instaunit which combines HTTP API integration tests with documentation generation, since these two things must always be maintained in lockstep.

    It's got a ways to go before it generates output that looks as good as Stripe's documentation, but it makes it dead simple to create API documentation that's guaranteed to be in sync with your service, because it was generated by your tests when they ran.

    https://github.com/instaunit/instaunit

  • Sonar

    Write Clean JavaScript Code. Always.. Sonar helps you commit clean code every time. With over 300 unique rules to find JavaScript bugs, code smells & vulnerabilities, Sonar finds the issues while you focus on the work.

  • HedgeDoc

    HedgeDoc - The best platform to write and share markdown.

  • mm-docs

    Documentation system in a docker container using mkdocs, plantuml and many more

    I am glad to know there are those that put so much thought into documentation. Documentations is just another service, and deserves all the same methodology: CI/CD, tests, components, reuse etc.

    As far as I can see, you can get similar workflow with combination of existing tools. I created this docker image that combines them for very easy consumption and created thousands of pages of technical, functional and user documentation with it:

    https://github.com/majkinetor/mm-docs

  • remark

    remark is a popular tool that transforms markdown with plugins. These plugins can inspect and change your markup. You can use remark on the server, the client, CLIs, deno, etc. (by remarkjs)

    As someone who was about to use Remark (https://github.com/remarkjs/remark) and Next.js to start a new blog, does this solve something that Remark doesn't? Genuinely curious.

  • rst2nitrile

    convert rst to latex books

    Last week I ported my static physical book building tooling from rst-based [0] to markdown (pandoc filter) based.

    I've used my rst tooling to publish many books (like Effective Pandas) and am wanting to drop rst in an effort to simplify my life. My pandoc toolchain is not in github yet, but preliminary exploration validates that I can publish my next physical book with it (with things like front matter, indices, etc).

    In the process I messed around with MyST and mistletoe. I dropped MyST because it was evident I would need to mess around with Sphinx again. Been there done that. Too much abstraction.

    Mistletoe would have worked too (I need to create custom fences/markup for a few features) but I wanted to see if I could do it with Pandoc.

    The Pandoc distinction between Blocks and Inlines is annoying as is the requirement to handle everything at once. With Pandoc, you only get notified at the start of an element, not the end which probably complicates it a bit more than Mistletoe would have.

    (I still need to port my slide generation tooling and will probably use mistletoe for that. For epub generation I think I will stick with Pandoc.)

    0 - https://github.com/mattharrison/rst2nitrile

  • esbuild-markdoc-plugin

    esbuild plugin for markdown files using markdoc

    If anyone is interested, I published my esbuild plugin so you don’t have to transform on the server if you want to just import a markdown file.

    https://github.com/toddw/esbuild-markdoc-plugin

  • stripe

    Go library for the Stripe API.

    Unfortunately my experience has been different; I found that Stripe's Go doc doesn't match their API and while searching on it I found that someone else had mentioned that to their personnel over freenode 2 years ago.

    So I raised an issue on GitHub[1] on Apr 9 and hasn't been attended to yet.

    On a more serious note, Stripe's payment links doc seemed to imply that tax rates are automatically calculated if the tax rates are set(as we do with code when we pass the tax_id), But I found after couple of payments that tax aren't being charged, On conversing on Twitter with the payment links dev I came to realize that the required option was not there for me[2] and then after couple of hours with their support staff I was informed that the options was not available for India as 'Stripe Tax' is a separate product.

    Overall, I'm happy with Stripe's tech; at least compared to the other options I have. But their docs have caused me some frustrations.

    [1] https://github.com/stripe/stripe-go/issues/1447

    [2] https://twitter.com/joshuaackerman/status/144759582096702259...

  • python

    A Python handler for mkdocstrings. (by mkdocstrings)

  • crystal

    📘 Crystal language doc generator for https://github.com/mkdocstrings/mkdocstrings (by mkdocstrings)

  • mkdocstrings

    :blue_book: Automatic documentation from sources, for MkDocs.

    Author of Materia for MkDocs here. MkDocstrings [1] implements automatic generation of reference documentation from sources. It's language-agnostic, actively maintained and currently supports Python [2] and Crystal [3]. It also integrates nicely with Material for MkDocs.

    [1]: https://mkdocstrings.github.io/

  • fastapi

    FastAPI framework, high performance, easy to learn, fast to code, ready for production

  • Zigi

    The context switching struggle is real. Zigi makes context switching a thing of the past. It monitors Jira and GitHub updates, pings you when PRs need approval and lets you take fast actions - all directly from Slack!

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts