Moving Config Docs From YAML to Markdown

• Docusaurus

  282 52,824 9.5 TypeScript

  Easy to maintain open source documentation websites.

  

Since our docs are in Docusaurus, I could have left the tables in HTML, but once they were in HTML the move to Markdown is pretty well supported by various free tools.

• zeebe

  6 3,030 10.0 Java

  Distributed Workflow Engine for Microservices Orchestration

  

You can Ctrl + F (or Command + F) your way through the file, but you have to know what you are looking for.

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

  

• yaml-to-table

  1 32 10.0 Python

  Convert YAML file to text/html table for documentation

From there, I took the lazy(ish) approach and used https://github.com/ishswar/yaml-to-table, which didn't work without some changes. Instead of copying the descriptions, it added ipsum... ugh.

Suggest a related project