| .marp | ||
| docs | ||
| scripts | ||
| slides | ||
| .dockerignore | ||
| .gitignore | ||
| .gitmodules | ||
| Dockerfile | ||
| Makefile | ||
| mkdocs.yml | ||
| package-lock.json | ||
| package.json | ||
| Pipfile | ||
| Pipfile.lock | ||
| Procfile | ||
| QUESTIONS.md | ||
| README.md | ||
| REFERENCES.md | ||
Teaching-Boilerplate
Prerequisites
Make sure you have python and node installed
Install python packages
pip install -U pipenv
pipenv install
Install node packages
npm install
Usage
Watch mode
This mode allows you the result on-the-fly as you makea changes in the content.
To use watch mode, type:
make watch
To use watch mode for slides only type:
make watch-slides
To use watch mode for docs only type:
make watch-docs
Build mode
This mode builds final content for delivery (website, PDF files)
To use build mode:
make build