Obsidian x Markdown - Style Conventions

  • ATOM
  • 5d ago

Markdown is a wide spec that accommodates a variety of use-cases, but Markdown-in-Obsidian suggests certain “best practices” that best fit the environment.

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

  • Obsidian x Markdown - Style Guide - Naming
  • Filesystem things
    • My Obsidian vault filetree
    • Heirarchies - top-down or bottom-up
  • Knowledge
    • Reference vs. Resource vs. Reflection
    • Non-md files
    • Assets, Clips, Lit Notes
  • Metadata
    • Avoid repetitive note clutter (e.g. breadcrumb structure, journal footer meta)
  • Workflow
    • Inbox folder (not working. frontmatter property?)
    • Publishing
  • Note structure
    • Callouts

resources

Note Relations

Down