dev@api@doc

API Documentation Tools

G: api documentation generator git markdown

• https://www.gatsbyjs.org/
• https://github.com/myles/awesome-static-generators#documentation
• https://docpad.org/
• https://docute.org/guide/customization
• http://www.sphinx-doc.org/en/master/
• https://docsify.js.org/#/
• https://www.mkdocs.org/
• https://metalsmith.io/
• https://github.com/lord/slate
• https://apiblueprint.org/
• https://dotnet.github.io/docfx/
• https://docusaurus.io/

G: markdown diagram

• https://support.typora.io/Draw-Diagrams-With-Markdown/ // Editor beta
  • https://bramp.github.io/js-sequence-diagrams/
  • http://flowchart.js.org/
• Mermaid: https://mermaidjs.github.io/
  • Markdown Plus - Markdown editor with extra features
  • gitbook-plugin
    • https://github.com/GitbookIO/gitbook
    • https://legacy.gitbook.com/editor
  • Confluence plugin
  • Using mermaid via docpad
  • Using mermaid in Jekyll
  • Using mermaid via Octopress
  • Using mermaid via Gatsby
    • https://www.gatsbyjs.org/
  • Mardown editor Haroopad // Editor beta
  • Sphinx extension // Python
  • Pandoc filter
    • https://pandoc.org/
  • hads
  • Mermaid Preview for VS Code // Editor
  • Package for Sublime Text 3 // Editor

---

Inspiration:

• https://www.staticgen.com/

• https://github.com/lord/slate/wiki/Slate-in-the-Wild, https://docs.dwolla.com/#create-a-document-for-a-customer, https://github.com/pnerger/dpSlate, https://github.com/X1011/git-directory-deploy, https://github.com/dojo/dapi/wiki, https://dojotoolkit.org/api/, https://github.com/facebook/Docusaurus/issues/789, https://facebook.github.io/react-native/docs/getting-started, https://bucklescript.github.io/docs/en/interop-overview, https://segment.com/blog/building-technical-documentation-with-metalsmith/

• Markdown Lorem Ipsum: https://jaspervdj.be/lorem-markdownum/

  • https://daringfireball.net/projects/markdown/syntax

• AsciiDoc

  • http://www.cirosantilli.com/markdown-style-guide/#use-asciidoc
  • Diagraming:
    • https://asciidoctor.org/docs/asciidoctor-diagram/
  • Antora: https://antora.org/ (JS)
    • Showcase: https://docs.antora.org/antora/2.0/install/install-antora/
    • Insert an image: https://docs.antora.org/antora/2.0/asciidoc/insert-image/
    • Link with Asciidoctor extensions:
      • https://gitlab.com/antora/antora-asciidoctor-extensions
      • https://gitlab.com/antora/antora/issues/138
      • https://github.com/markushedvall/plantuml-encoder
      • https://medium.com/@yfuruyama/real-world-plantuml-7365ffc1b6e6
      • http://plantuml.com/
      • https://github.com/asciidoctor/asciidoctor-diagram/issues/183
      • https://puravida-software.gitlab.io/asciidiagram/
      • https://gitlab.com/puravida-software/asciidiagram
  • AsciiBinder http://asciibinder.org/ (Ruby / JRuby)
    • Superseeded by Antora

• Example of a huge adoc: https://github.com/cirosantilli/linux-kernel-module-cheat/blob/v3.0/README.adoc

• Asciidoc doc: http://www.methods.co.nz/asciidoc/userguide.html