Skip to content

Repository files navigation

Frontend

This code is the frontend for the O(fast) platform.

Creating Lessons

  • Our lessons are created using MDX, which combines JSX and markdown.

  • We do not support dynamic imports/exports. However, we provide some statically imported components for incorporating common lesson features:

  • For writing lessons and viewing rendered MDX code in the O(fast) environment, feel free to utilize O(fast)'s MDX Playground.

  • Open src/lessons.json and add an entry for the new lesson. The key should be a lesson ID that is not already used by other lessons. The value should be an object with the properties: lessonName, lessonGroup, and files. The lessonName property stores a string with the lesson's name. The lessonGroup property stores a string with the name of the lesson group the lesson belongs to. These two properties are used to create and categorize a link to the lesson on the Learn page. files is an array of strings that represent the paths to mdx lesson files, which store the lesson content.

  • Go to public/lessons and create a new subdirectory with the name of the lesson ID created in the previous step. Inside this folder, create mdx files to write lesson content in. If you haven't already, go back to src/lessons.json and populate the files array with the paths to these mdx files, relative to the new lesson subdirectory. In most cases this will simply be the names of the mdx files.

  • Refer to existing entries in src/lessons.json for examples.

About

Resources

Stars

3 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages