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
56 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 1e7c0ed279 doc: improve update-toc output
2021-06-27 21:34:12 +02:00
.marp chore: make sure theme.css cleanup when build fails 2021-04-15 15:42:27 +02:00
docs style: improve filesystem organization 2021-04-15 15:14:24 +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 doc: improve update-toc output 2021-06-27 21:34:12 +02:00
slides Add symlinks for images 2021-04-13 02:34:55 +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-04-15 15:41:36 +02:00
.gitmodules Initial import 2018-04-20 17:27:59 +02:00
.tool-versions Bump tool-versions 2021-06-27 20:45:30 +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: target update-toc must behave like build or watch 2021-06-27 21:20:25 +02:00
mkdocs.yml Disable plugins (for broken search) 2021-04-12 00:52:23 +02:00
package-lock.json Force python & packages versions 2021-04-11 22:24:27 +02:00
package.json Bump marp dependencies 2021-06-27 20:33:21 +02:00
Pipfile Merge branch 'master' of github.com:glenux/teaching-boilerplate 2021-06-27 20:32:27 +02:00
Pipfile.lock Add mkdocs-gitbook extension 2021-04-12 00:51:17 +02:00
Procfile Procfile: use internal tasks to prevent loop 2020-09-03 11:32:12 +02:00
README.md Add documentation 2020-04-19 12:07:35 +02:00

README.md

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