Template for vuepress-based lesson websites.
NOTE! This is a template site, so use the template, don't clone it.
To install the lesson builder, first install pipx then install
lesson-builder
with pipx:
pipx install git+https://github.com/league-infrastructure/lesson-builder.git
Install vuepress, if you haven't already. See these instructions for details.
in this example, we will be using yarn
rather than npm
to install vuepress.
If you have installed yarn previously, you will still need to install in the docs dir
(cd docs && yarn install )
Now you can build your website.
$ jtl -vv build
INFO:lesson_builder.cli.jtl:Using url base 'LevelX'
INFO:lesson_builder.lesson:Writing lesson plan to docs/src/lessons
DEBUG:lesson_builder.lesson:Writing Lesson Introduction to Tina the Turtle to docs/src/lessons/introduction-to-tina-the-turtle
DEBUG:lesson_builder.lesson: Copying flag.png to docs/src/lessons/introduction-to-tina-the-turtle
DEBUG:lesson_builder.lesson: Writing Shapes and Colors
jtl serve
If you get errors, it maybe because you need to install packages with yarn. Try: (cd docs && yarn install )
If it works, visit the url duisplayed to see your site.