🟢 | Docker images for use with docmachine-cli
Find a file
2020-04-19 12:27:59 +02:00
.marp Add configuration for dependencies 2020-04-19 12:04:32 +02:00
docs Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +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
mindmaps Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
scripts Add script for updating mkdocs toc 2020-04-19 12:07:56 +02:00
slides Add directory structure 2020-04-19 12:05:41 +02:00
.dockerignore Add directories for examples & exercises 2020-04-19 12:20:53 +02:00
.gitignore Improve gitignore 2020-04-19 12:07:26 +02:00
.gitmodules Initial import 2018-04-20 17:27:59 +02:00
Dockerfile Initial import 2018-04-20 17:27:59 +02:00
Makefile Upgrade makefile for both slides & docs 2020-04-19 12:03:43 +02:00
mkdocs.yml Add configuration for dependencies 2020-04-19 12:04:32 +02:00
package-lock.json Fix npm security vulnerabilities 2020-04-19 12:09:34 +02:00
package.json Fix npm security vulnerabilities 2020-04-19 12:09:34 +02:00
Pipfile Add configuration for dependencies 2020-04-19 12:04:32 +02:00
Pipfile.lock Add configuration for dependencies 2020-04-19 12:04:32 +02:00
Procfile Add configuration for dependencies 2020-04-19 12:04:32 +02:00
QUESTIONS.md Add documentation 2020-04-19 12:07:35 +02:00
README.md Add documentation 2020-04-19 12:07:35 +02:00
REFERENCES.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