- π intended mainly for education at FIT CTU
- π¦ built on top of docusaurus library
- π₯ slides and examples are built by using parcelJS pipeline
project
β
ββββexamples // coding examples
β β assets // assets that are copied into build folder
β β libs // libraries for examples and demo projects
β β src // source files
β β view // PUG templates that are bundled by Parcel
β
ββββscripts // scripts for pre-build, post-build, deployment etc.
β
ββββslides // RevealJS-powered slides
β β assets // assets (images, svg files, code snippets)
β β backgrounds // background files for presentations
β β plugins // RevealJS plugins
β β themes // RevealJS themes (including APH theme for slides)
β β view // PUG templates with all texts and declarations
β
ββββwiki // docusaurus-powered wiki
β β blog // place for a blog... not used right now
β β docs // markdown documents with instructions, tutorials, guides etc.
β β plugins // some plugins
β β src // React sources with custom components and themes
β β static // static files (slides and examples are copied into this folder)
β β types // additional Typescript declarations
β
β CHANGELOG.md // changelog
β package.json // npm scripts and dependencies
β README.md // README file
β tsconfig.json // typescript config (only for pre-build)
β tslint.json // typescript linter settings for static checking
- clone it
- install nodeJS, LTS version if possible
- execute
npm install
- if you want to build the examples, run
npm run dev-examples
and navigate tolocalhost:1234/index.html
- if you want to build the slides, run
npm run dev-slides
and navigate tolocalhost:1234/index.html
- if you want to build the wiki:
- go to wiki folder
- execute
npm install
- execute
npm start
and navigate tolocalhost:3000
- if you want to build everything
- execute
npm run deploy-all
from the root folder. Everything gets bundled intobuild_wiki
- execute
Changelog is available here
- the current version is deployed on aphgames.io