glenux/docmachine-containers
glenux/docmachine-containers
1
0
Fork 0
Code Issues Pull requests Projects 1 Releases Packages Wiki Activity
🟢 | Docker images for use with docmachine-cli
81 commits 5 branches 0 tags 1,022 KiB
Makefile 32.1%
Ruby 18.1%
SCSS 17.4%
Python 17%
Dockerfile 4.5%
Other 10.9%
Find a file
Glenn Y. Rolland 163cfb9dce Update usage instructions
2021-07-21 13:58:16 +02: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 highlight.js from 9.18.1 to 10.7.3 2021-06-27 21:46:49 +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 Update usage instructions 2021-07-21 13:58:16 +02:00

README.md

Teaching-Boilerplate

Prerequisites

Make sure you have python and node installed

git remote rename origin boilerplate
git remote add origin git@...

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