macana

Static site generator for Obsidian Vault

  1. 1
  2. 2
  3. 3
  4. 4
  5. 5
  6. 6
  7. 7
  8. 8
  9. 9
  10. 10
  11. 11
  12. 12
  13. 13
  14. 14
  15. 15
  16. 16
  17. 17
  18. 18
  19. 19
  20. 20
  21. 21
  22. 22
  23. 23
  24. 24
  25. 25
  26. 26
  27. 27
  28. 28
  29. 29
  30. 30
  31. 31
  32. 32
  33. 33
  34. 34
  35. 35
  36. 36
## Document

A parsed note or canvas in a Vault.
A *document* consists of *document metadata* and *document content*.

## Document metadata

Properties describing a *document* or a *document directory* required for generating a website.
*Document metadata* consists of a *document name* and *document title*.

## Document name

An identifier for a document, unique among a directory the document belongs to.
A *document name* appears in a generated URL, thus available characters are limited to:

- Alphabet (`a-z`, `A-Z`)
- Digit (`0-9`)
- Percent symbol (`%`)
- Hyphen (`-`)
- Dot (`.`)
- Underscore (`_`)
- Tilde (`~`)

## Document title

Human-readable text representing a title of the *document*.
Although there is no restriction on available characters, you should avoid using control characters. ([Unicode control characters - Wikipedia](https://en.wikipedia.org/wiki/Unicode_control_characters))

## Document directory

A directory (folder) containing *document metadata* and *document directories*.
A document directory consists of *document metadata* of its own and zero or more *document metadata* and/or *document directory*.

## Document tree

Tree structured data contains *document metadata* and *document directories* per locales.