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
---
createdAt: 2024-04-09T21:00:00+09:00
updatedAt: 2024-04-18T07:35:00+09:00
---

Obsidian Flavored Markdown (OFM) is an authoring format used in Obsidian, based on CommonMark and [[GitHub Flavored Markdown]] (GFM).
This page lists extensions not exists in both CommonMark and GFM.

- Brief description: https://help.obsidian.md/Editing+and+formatting/Obsidian+Flavored+Markdown
- Basic syntax list: https://help.obsidian.md/Editing+and+formatting/Basic+formatting+syntax

Unfortunately, Obsidian does not publish a formal spec for the OFM.
Users should be aware Macana's OFM parser is not guaranteed to be 100% compatible with Obsidian's one, as the spec is not defined and even Obsidian behave inconsistent in some area.

## Wikilink extension

```markdown
- [[GitHub Flavored Markdown|GFM]]
- [[Overview]]
```

- [[GitHub Flavored Markdown|GFM]]
- [[Overview]]

Document embedding is not supported yet.

## Highlight extension

```markdown
==Hello, World!==
```

==Hello, World!==

## Callout extension

```markdown
> [!info]+ Title, [[GitHub Flavored Markdown]]
> Both title and body can contain Markdown.
```

> [!info]+ Title, [[GitHub Flavored Markdown]]
> Both title and body can contain Markdown.

## Image size attribute

OFM abuses image `alt` slot for size specifier.
You can inspect the `<img>` tags below to see how it affects the resulting markup.

```markdown
![Picture of my dog|64](../../Assets/dog.jpg)
![Picture of my dog|64x32](../../Assets/dog.jpg)
![Picture of my dog|128x128](../../Assets/dog.jpg)
![[dog.jpg|64]]
```

![Picture of my dog|64](../../Assets/dog.jpg)
![Picture of my dog|64x32](../../Assets/dog.jpg)
![Picture of my dog|128x128](../../Assets/dog.jpg)
![[dog.jpg|64]]