diff --git a/README.md b/README.md index 57a2c1c..77e8072 100644 --- 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 new file mode 100644 index 0000000..704ebb3 Binary files /dev/null and b/media/preview_of_info_boxes.png differ