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
  37. 37
  38. 38
  39. 39
  40. 40
  41. 41
  42. 42
  43. 43
  44. 44
  45. 45
  46. 46
  47. 47
  48. 48
  49. 49
  50. 50
  51. 51
  52. 52
  53. 53
  54. 54
  55. 55
  56. 56
  57. 57
  58. 58
  59. 59
  60. 60
  61. 61
  62. 62
  63. 63
  64. 64
  65. 65
  66. 66
  67. 67
  68. 68
  69. 69
  70. 70
  71. 71
  72. 72
  73. 73
  74. 74
  75. 75
  76. 76
  77. 77
  78. 78
  79. 79
  80. 80
  81. 81
  82. 82
  83. 83
  84. 84
  85. 85
  86. 86
  87. 87
  88. 88
  89. 89
  90. 90
  91. 91
  92. 92
  93. 93
  94. 94
  95. 95
  96. 96
---
createdAt: 2024-04-15T23:00:00+09:00
updatedAt: 2024-05-05T00:05:00+09:00
---
## v1.0

- [ ] Diagram extension (abuse) for Markdown.
- [ ] Search
- [ ] Wikilink embed for search result
- [ ] Tags
- [ ] Development server (optional goal)

## v0.4

- [ ] Style every tags generated by Markdown
- [ ] Anchor link next to heading
- [ ] Option for OpenGraph attributes
- [ ] Custom fonts per language
- [ ] User provided global CSS

## v0.3

- [ ] CLI for opinionated build
- [ ] JSON/JSONC config for CLI
- [ ] Usage document for CLI
- [ ] Wikilink internal hash reference
- [ ] Option to set base URL or path

## v0.2

- [ ] Resolve document internal wikilink
- [ ] Headings down levelling option (render `# Foo` as `<h2>Foo</h2>`)
- [x] Client script to retain open/close state of document tree
- [ ] Client script to sync active table of contents entry to current scroll position
- [ ] Client script to close site menu on navigation event

## v0.1

- [x] Using Vault as a site structure
- [x] Markdown Parsing
	- [x] CommonMark
	- [x] GitHub Flavored Markdown
		- [x] Strikethrough
		- [x] Task Lists
		- [x] Footnotes
		- [x] Autolinks
		- [x] Tables
		- [x] Math ... ~No support if MathJax can't generate MathML at build time.~ Using Temml instead.
	- [x] Syntax Highlighting
	- [x] Obsidian Extensions
		- [x] Internal Link path resolution
			- [x] Absolute path in vault
			- [x] Absolute path in vault (extension-less)
			- [x] Relative path to file
			- [x] Relative path to file (extension-less)
			- [x] Shortest path when possible
		- [x] Wikilink
			- [x] Label
			- [x] Heading
			- [x] Block reference
		- [x] Defining a block
		- [x] Image size annotation
		- [x] Embeddings
			- [x] Image file
			- [x] Audio file
			- [x] PDF file
			- [x] Another document
		- [x] ==Highlight==
		- [x] Callouts
		- [x] Comments %% You can check this item once I'm no longer visible %%
		- [x] Strip Raw HTML (only `<title>` is troublesome, but align behavior to Obsidian's)
			- [x] `<script>` <script>console.log("This tag should be eliminated: escaping is not suffice")</script>
			- [x] `<title>` <title>Foo</title>
			- [x] `<style>` <style>* { display: none; }</style>
		- [x] Keep Raw HTML (Unified libraries tends to ignore spec by default, needs to opt-out)
			- [x] <span style="color: red; background-color: yellow;">Colored text</span>
- [x] JSONCanvas
	- [x] Node rendering
		- [x] Basic shapes
		- [x] Colors
		- [x] Text node
		- [x] Group node
		- [x] Link node
		- [x] File node
	- [x] Edge rendering
		- [x] Basic shape
		- [x] Arrow
		- [x] Colors
		- [x] Label
- [x] Document sorting
- [x] Creation / Update date
- [x] Config for site logo
- [x] Tool's logo
- [x] Proper styling
- [x] Switch to drawer menu when side navigation cannot fit
- [x] Library usage document