Updated readme and described the highlight function

mage-os · Jun 28, 2023 · 5166dad · 5166dad
1 parent a161659
commit 5166dad
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,25 @@
 
 You can find the online version of the Mage-OS documentation at [https://devdocs.mage-os.org/](https://devdocs.mage-os.org)
 
+## Markup and Features
+
+We support GitHub Flavored Markdown, including code blocks with triple backticks. You can also add highlight areas
+within you documentation.
+
+![Preview of Markdown rendered Info Boxes](media%2Fpreview_of_info_boxes.png)
+
+```markdown
+> **Note**  
+> Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime perspiciatis quae sapiente sunt veniam, voluptatum?
+
+> **Warning**  
+> Lorem ipsum dolor sit amet, consectetur adipisicing elit. Aut dignissimos dolorum exercitationem fuga maxime perspiciatis quae sapiente sunt veniam, voluptat?
+```
+
+For more details, see the [GitHub Flavored Markdown documentation](https://help.github.com/articles/github-flavored-markdown/).
+
+
+
 ## Contribution Guidelines
 
 If you are submitting documentation for the **current stable release**, submit it to the corresponding branch. For

diff --git a/media/preview_of_info_boxes.png b/media/preview_of_info_boxes.png