glenux/docmachine
glenux/docmachine
1
0
Fork 0
Code Issues Pull requests Packages Projects 1 Releases Wiki Activity
🟢 Stable | Docker image for docmachine-utils
48 commits 5 branches 0 tags 810 KiB
Makefile 32.7%
Ruby 18.4%
Python 17.3%
SCSS 15.8%
Dockerfile 4.6%
Other 11.2%
Go to file
Glenn Y. Rolland b828693cb6 chore: ignore marp theme.css & sort ignored files
2021-06-27 23:45:49 +02:00
.marp Add a Makefile for marp 2021-03-09 08:57:39 +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 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 Ignore files starting with _ 2021-03-09 09:42:13 +01: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 Force python & packages 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 feature: Add ORA -> PNG support in Makefile 2021-04-10 12:53:44 +02:00
mkdocs.yml Disable plugins (for broken search) 2021-06-27 23:45:49 +02:00
package-lock.json Force python & packages versions 2021-06-27 23:45:49 +02:00
package.json Fix npm security vulnerabilities 2020-04-19 12:09:34 +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 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