🟢 | Docker images for use with docmachine-cli
Find a file
2022-01-25 17:09:21 +01:00
.github/workflows CI: add support for test 2022-01-25 17:09:21 +01:00
.makefiles@d5627404e1 Update .makefiles 2022-01-25 17:09:21 +01:00
.marp style: Fix design of slides 2022-01-25 17:09:21 +01:00
docker Add support for unzip 2022-01-25 17:09:21 +01: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 Add sample images for .dot and .circo 2022-01-25 17:09:21 +01:00
mindmaps Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
scripts scripts: make slides/docs optional (in case of missing directory) 2022-01-25 17:09:21 +01:00
slides Add support for mdpp slides 2022-01-25 17:09:21 +01: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 Add dependency to makefiles-forever 2022-01-25 17:09:21 +01:00
.tool-versions Bump tool-versions 2021-06-27 23:45:49 +02:00
docker-compose.yml Update docker scripts 2022-01-25 17:06:26 +01:00
Makefile Remove tocupdate 2022-01-25 17:09:21 +01:00
mkdocs.yml Use sane defaults for 2-level depth 2022-01-25 17:09:21 +01:00
package-lock.json fix: update Marp because of chrome bug[F 2022-01-25 17:09:21 +01:00
package.json fix: update Marp because of chrome bug[F 2022-01-25 17:09:21 +01:00
Pipfile Add plugins from vedem-doc 2022-01-25 17:09:21 +01:00
Pipfile.lock chore: update Pipfile.lock 2022-01-25 17:09:21 +01:00
Procfile fix: Make sure watch works for tocupdate target 2021-06-27 23:45:49 +02:00
README.md Add missing doc line 2022-01-25 17:06:26 +01:00

Teaching-Boilerplate

Prerequisites

Make sure you have python and node installed

git remote rename origin boilerplate
git remote add origin git@...
git checkout -b upstream/boilerplate/master --track

Install python packages

pip install -U pipenv
pipenv install

Install node packages

npm install

Usage

First steps

Clean this repository

Change the remote

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