Skip to content

tips for bqt doc writers

hannes edited this page Jun 21, 2023 · 1 revision

starter tips for doc writers

These docs are edited with Obsidian:

  • use [[title of note]] to link to a page (this is called wikilink)
  • select text, and paste a URL on it to link to other sites.
  • use # , ## or ### in front of a sentence to create a header.
  • GitHub wiki is less advanced than Obsidian, avoid fancy features that only work in Obsidian.
  • A new line in GitHub requires the previous line to end in 2 spaces. This wont show in Obsidian.
  • chapters that need more work are flagged with the #todo 👷 hashtag. Search for it in Obsidian by clicking the tag.