Skip to content

Referencing notes by title#

  • Currently we reference notes with [Description](desription.md) syntax.
  • Pros
    • Supported by all static site generators
    • Supported by Markdown All in One
  • Cons
  • Possible syntaxes
  • [Title of page]
    • Pro: Already supported by Markdown and GH Pages publishing
    • Con: Possibly syntactically ambiguous
  • [[Title of page]]
  • `[[title_of_page.md]]
  • Keep current syntax, but automate linking, e.g. a snippet/shortcut to:
    • Insert []() (opens file autocompletion)
    • Once file is chosen in (), populate the description in [] automatically from page tite
    • Pros: Compatible with Markdown All in One
    • Cons: Not as sleek as other options
  • Can MDX help us here?