This script generates a markdown file from the notes you wrote on Frontend Masters or Josh Comeau courses.
It takes the exported json file with your notes and convert it to a markdown file.
Note
UPDATE NOTE: Nowadays Frontend Masters lets you export a markdown file right away from their platform. The output this project produces is a bit different since it has been developed on my own preferences, you can give it a try if you want anyways.
- Clone this repository
- Download the json file with your notes from the course platform.
- Add the json file inside
sourcesdirectory, rename it:data.json. - Launch the script with
npm start - The file will be generated inside
distdirectory
-
Feedback is appreciated! This is an implementation I found convenient for myself (a really opinionated implementation at least), any suggestions you have will be welcome.
-
You can generate a version without timestamp links by running
npm start -- nolinksat step 4.
- Install dependencies with:
npm install - Download the json file from Josh Comeau's course platform.
- Add the json file inside
sourcesdirectory, it should be called:notes.json. - Launch the script with:
npm run josh-course-parser- The file will be generated inside
distdirectory
You can pass options preceeded by -- to define custom input, output and course type:
npm run josh-course-parser -- --course="css" More examples on this table:
| Option | Shorthand | Example | Default value |
|---|---|---|---|
| --input | -i | npm run josh-course-parser -- -i "./mynotes.json" | "./sources/notes.json" |
| --output | -o | npm run josh-course-parser -- --output="./mynotes.md" | "./dist/notes.md" |
| --course | -c | npm run josh-course-parser -- -c "css" -o "./css-notes.md" | "js" |
By default it will parse notes from The Joy Of React course.
You can change the option --course in case you need notes for CSS in React or the new Whimsical Animations course.
Available options for this are js, css or animations.