🟢 Stable | Docker image for docmachine-utils
Go to file
2021-11-25 20:22:28 +01:00
.github/workflows CI: fix syntax for environment variables in GITHUB 2021-11-25 17:04:03 +01:00
.makefiles@d5627404e1 Update .makefiles 2021-07-23 16:16:58 +02:00
.marp style: Add support for bc-title 2021-11-25 20:22:28 +01:00
docker Update docker scripts 2021-11-23 23:46:50 +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 2021-07-23 16:52:57 +02:00
mindmaps Rename .directory files to .empty to prevent conflicts with some file managers 2020-04-19 12:27:59 +02:00
scripts script: fix volumes in gx-teaching 2021-11-25 18:44:46 +01:00
slides Add support for mdpp slides 2021-07-23 16:15:53 +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 Add dependency to makefiles-forever 2021-07-23 15:51:26 +02:00
.tool-versions Bump tool-versions 2021-06-27 23:45:49 +02:00
docker-compose.yml Update docker scripts 2021-11-23 23:46:50 +01:00
Makefile make: fix docker commands 2021-11-25 18:44:26 +01:00
mkdocs.yml Add plugins from vedem-doc 2021-11-25 16:39:10 +01:00
package-lock.json Merge pull request #17 from glenux/dependabot/npm_and_yarn/tar-6.1.11 2021-11-24 19:24:07 +01:00
package.json Bump marp dependencies 2021-06-27 23:45:49 +02:00
Pipfile Add plugins from vedem-doc 2021-11-25 16:39:10 +01:00
Pipfile.lock build(deps): bump mkdocs from 1.2.1 to 1.2.3 2021-11-23 22:50:56 +00:00
Procfile fix: Make sure watch works for tocupdate target 2021-06-27 23:45:49 +02:00
README.md Add missing doc line 2021-07-21 13:59:28 +02: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