Skip to content

Instantly share code, notes, and snippets.

@sogaiu
Last active April 21, 2025 06:29
Show Gist options
  • Save sogaiu/cd8989cbbe0b923363dc05225facf9ad to your computer and use it in GitHub Desktop.
Save sogaiu/cd8989cbbe0b923363dc05225facf9ad to your computer and use it in GitHub Desktop.
janet doc-format notes

Background

Janet's docstrings "support some subset of Markdown"...but exactly what?

Notes

some amount of support for

  • indented code blocks
  • fenced code blocks
  • paragraphs
  • list items
  • lists
    • unordered lists
    • ordered lists
  • code spans (e.g. `nil`)
  • emphasis and strong emphasis - underline [1], italics, bold

may not support

  • thematic breaks
  • atx headings
  • setext headings
  • link reference definitions
  • block quotes
  • loose lists?
  • links
  • images

[1] Technically, it seems there is no support for underline in Markdown / CommonMark

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment