markdown-rules.md

Markdown rules

This application uses Docusaurus, which creates documentation pages from .md (Markdown) and .mdx (Markdown + JSX) files. Docusaurus compiles each type into a React component. However, if during compilation it encounters invalid markup or markup it is unsure of, the compiler will stop and return an error.

Therefore, it is a requirement that Markdown files are properly formatted otherwise this application can crash. When running the import script in this application, it will attempt to compile each Markdown file to ensure there are no errors present otherwise the file will be skipped.

Documentation and various tools that can assist in validation markdown content:

• Docusaurus markdown features
• GitHub has several in-depth pages regarding Markdown, formatting, syntax and advanced usage.
• Markdown basics and 10 minute tutorial
• MDX Playground Here you can toggle between Input format as MDX or markdown to test Markdown compilation