Stripe Open Sources Markdoc

• docs

  2 128 4.8 JavaScript

  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

  93 18,123 9.8 HTML

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

• SurveyJS

  surveyjs.io

  sponsored

  Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

  

• docs

  1 93 9.4 JavaScript

  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

  99 16,788 8.7 JavaScript

  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

  1 83 10.0 Stata

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

• Docusaurus

  282 52,686 9.5 TypeScript

  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

  2 22 3.7 Go

  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

• WorkOS

  workos.com

  sponsored

  The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

  

• HedgeDoc

  48 4,639 9.9 TypeScript

  HedgeDoc - Ideas grow better together

  

• mm-docs

  2 16 5.6 PowerShell

  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

  42 7,172 6.9 JavaScript

  markdown processor powered by plugins part of the @unifiedjs collective (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

  1 7 10.0 Python

  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

  3 14 0.0 JavaScript

  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

  8 1,990 9.0 Go

  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

  1 147 8.7 Python

  A Python handler for mkdocstrings. (by mkdocstrings)

  

• crystal

  1 27 6.8 Python

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

  

• mkdocstrings

  9 1,553 8.3 Python

  :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

  462 70,541 9.7 Python

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

• InfluxDB

  www.influxdata.com

  sponsored

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

Suggest a related project