Markdown documentation format concept
Joe Pea

Joe Pea @trusktr

Joined:
Aug 20, 2018

Markdown documentation format concept

Publish Date: Dec 31 '20
9 2

Hello! I made a documentation format concept in Markdown.

Please let me know what you think. Can we make it more readable?

Comments 2 total

  • ᴀʙʜɪɴᴀᴠ sʜᴀʀᴍᴀ✩
    ᴀʙʜɪɴᴀᴠ sʜᴀʀᴍᴀ✩Jan 1, 2021

    This is neat! I was in search of technical documentation in Markdown. You laid it out pretty well. One question though, why did you make it as a Gist?

    • Joe Pea
      Joe PeaJan 2, 2021

      Thanks! I made it a gist because I like using gists as a markdown scratchpad, and plus then I'll know what it looks like directly on GitHub (as opposed to other online editors that may have differences one you publish on GitHub). Plus it supports comments. :)

      I made a doc generator (it reads JSDoc comments). So this will be what the markdown output will look like.

Add comment