💜 Obsidian+Markdown Style Guide

Goals:

• ⏰ Encourage long-term maintainability
• 🧱 Enforce standard, systematic, and predictable design patterns
• 🧠 Reduce mental cognitive load (during both writing, and retrieval)
• 📤 Make notes portable, especially ready for publishing to the web

Categories?

• Naming things (slug-friendly)
  • Prefer linking with the actual filename, instead of aliases or display text
  • Prefer unique filenames & aliases
  • Prefer declarative filename titles
  • Prefer positive instead of negative grammar
  • Prefer active over passive voice
  • Filenames vs. first H1 vs. frontmatter title
  • Frontmatter property naming (e.g. casing, shortform)
  • Name your subheadings like note titles
    • helps for eventually extracting sections into their own note
    • write your headings like their sections are their own notes
  • Prefer regular quotes in titles, but special quotes in prose??
  • Prefer using hyphens to delimit clauses
  • Prefer considering alphanumeric sorting for file names
  • Casing
    • prefer sentence case, but can capital case for artistic headings
    • Sources?
      • Books?
      • Videos?
      • Websites?
      • Quotes?
• Filesystem things
  • My Obsidian vault filetree
  • Heirarchies - top-down or bottom-up
• Knowledge
  • Reference vs. Resource vs. Reflection
• Metadata
  • Avoid repetitive note clutter (e.g. breadcrumb structure, journal footer meta)
• Workflow
  • Inbox folder (not working. frontmatter property?)
  • Publishing

↗ External Resources

• How I use Obsidian — Steph Angostephango.com