🟢 Stable | Docker image for docmachine-utils
Go to file
dependabot[bot] e3647aa35f
build(deps): bump y18n from 3.2.1 to 4.0.3
Bumps [y18n](https://github.com/yargs/y18n) from 3.2.1 to 4.0.3.
- [Release notes](https://github.com/yargs/y18n/releases)
- [Changelog](https://github.com/yargs/y18n/blob/y18n-v4.0.3/CHANGELOG.md)
- [Commits](https://github.com/yargs/y18n/compare/v3.2.1...y18n-v4.0.3)

---
updated-dependencies:
- dependency-name: y18n
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2021-06-27 21:46:47 +00:00
.marp chore: make sure theme.css cleanup when build fails 2021-06-27 23:45:49 +02:00
docs style: improve filesystem organization 2021-06-27 23:45:49 +02:00
examples Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
exercises Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
images feature: Add sample images files 2021-04-10 12:57:45 +02:00
mindmaps Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
scripts fix: Make sure watch works for tocupdate target 2021-06-27 23:45:49 +02:00
slides Add symlinks for images 2021-06-27 23:45:49 +02:00
.dockerignore Add directories for examples & exercises 2020-04-19 12:20:53 +02:00
.gitignore chore: ignore marp theme.css & sort ignored files 2021-06-27 23:45:49 +02:00
.gitmodules Initial import 2018-04-20 17:27:59 +02:00
.tool-versions Bump tool-versions 2021-06-27 23:45:49 +02:00
docker-compose.yml Add docker-compose file 2021-04-10 12:41:15 +02:00
Dockerfile fix: Add missing python & build tools in Dockerfile 2021-04-10 12:33:27 +02:00
Makefile fix: Make sure watch works for tocupdate target 2021-06-27 23:45:49 +02:00
mkdocs.yml Disable plugins (for broken search) 2021-06-27 23:45:49 +02:00
package-lock.json build(deps): bump y18n from 3.2.1 to 4.0.3 2021-06-27 21:46:47 +00:00
package.json Bump marp dependencies 2021-06-27 23:45:49 +02:00
Pipfile Add mkdocs-gitbook extension 2021-06-27 23:45:49 +02:00
Pipfile.lock Add mkdocs-gitbook extension 2021-06-27 23:45:49 +02:00
Procfile fix: Make sure watch works for tocupdate target 2021-06-27 23:45:49 +02:00
README.md Add documentation 2020-04-19 12:07:35 +02:00

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