Working with MDX
Explanation of how to use MDX when adding your own or modifying existing lessons.
Author: Jaden Park
Our repository is currently private, but feel free to email us if you're interested in working with us!
Incendium Academy uses MDX, a superset of Markdown, using the mdx-js compiler. HTML and React components are supported, so you can add them into your lessons.
For people new to Markdown syntax, here's a cheat sheet: Link
MetaData is the stuff in the beginning of every lesson/module (title, description, and author'(s) names).
The title of the module/lesson.
Description: Required A short description of the module/lesson.
Author: Required
The names of the authors who contributed.
There are 2 ways to write lessons.
OR
My personal recommendation is Obsidian (if you're not familiar with Github and making PR's) as you might use it in the future for note taking for school or work. However, if you were to run it locally, follow these steps.
git clone [insert link to repo]OR
npm installnpm run devIf you have trouble with running the website locally, feel free to create an issue or pull request on our Github repo.