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).

• Title: Required

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.

1. Using Obsidian, StackEdit, or other markdown renderers with $\LaTeX$ support

OR

2. Cloning the Github repository and running it on your machine locally.

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.

1. Set up your development environment.

• Install node.js

2. Clone the repository.

• Via command line: git clone [insert link to repo]

OR

• Using Github Desktop

3. Install the dependencies.

• npm install

4. Run the development server.

• npm run dev

If you have trouble with running the website locally, feel free to create an issue or pull request on our Github repo.