Add markdown compatibility note to documentation

michavie · Jul 2, 2021 · 3ade601 · 3ade601
1 parent 43f0075
commit 3ade601
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -62,3 +62,9 @@ This is useful for:
 - `published`: Notes tagged with this tag will mark the Statamic entry as published
 
 You can configure action tags to your preference in the `bearhub.php` config file.
+
+## Markdown
+
+By default, your notes are written using Bear's own Markup Language called [Polar](https://bear.app/faq/Markup%20:%20Markdown/Polar%20Bear%20markup%20language/). To have Bear and Statamic talk the same language, you most likely want to enable Bear's [Markdown Compatibility Mode](https://bear.app/faq/Markup%20:%20Markdown/Markdown%20compatibility%20mode/) in the app's settings:
+
+<p align="center"><img src="/art/markdown-compatibility.png" alt="Markdown Compatibility Mode Settings"></p>
diff --git a/art/markdown-compatibility.png b/art/markdown-compatibility.png