Skip to content

devlog.md

Latest commit

 

History

History
46 lines (28 loc) · 1.41 KB

devlog.md

File metadata and controls

46 lines (28 loc) · 1.41 KB

Technical points

The course is built with:

Install

npm ci

Start the presentation locally

If you want to start particular presentation - execute the next command where <presentation-name> should be equal to the lesson name

npm start <presentation-name>

Then open http://localhost:1234/

How to update documentation

All course related data should be stored in the course.json file. Updates should be done in the pre push phase automatically, with the help of Husky. To update documentation manually please execute the next command

npm run readme

If you need to tweak the documentation - check the _templates folder

How to add new presentation

  • Add new lecture to the course.json
  • Run npm run scaffold command without arguments

Deployment

Deployment is automated, appears after the push to the master branch and done with help github-pages-deploy-action

Encoding

Spotted that parcel or reveal doesn't like a lot of < > symbols - the code is completely messed. .replaceAll('>','&gt;') can fix this. Check encode.js file for details. Use it with npm encode.