🟢 Stable | Docker image for docmachine-utils
Go to file
Glenn Y. Rolland 0e364f496d
continuous-integration/drone/push Build is passing Details
feat: add support for rsync (needed by image subdirs)
2024-02-16 23:58:51 +01:00
.github/workflows ci: fix command in test job 2021-12-21 17:26:22 +01:00
.makefiles@d5627404e1 Update .makefiles 2021-07-23 16:16:58 +02:00
.marp fix: enable code highlight in marp 2024-02-16 23:56:36 +01:00
docker feat: add support for rsync (needed by image subdirs) 2024-02-16 23:58:51 +01:00
docs style: improve filesystem organization 2021-06-27 23:45:49 +02:00
docs.extra Add extra JS & CSS 2022-11-18 16:13:28 +01:00
images Add sample images for .dot and .circo 2021-07-23 16:52:57 +02:00
scripts chore: Remove script/docmachine* scripts now we have real tools 2023-04-06 20:22:22 +02:00
slides Add support for mdpp slides 2021-07-23 16:15:53 +02:00
.dockerignore fix: docker build must ignore drone file 2023-01-16 12:25:43 +01:00
.drone.yml ci: remove useless build step 2023-01-16 12:18:02 +01:00
.gitignore chore: ignore autoslide 2024-02-01 14:15:34 +01:00
.gitmodules Add dependency to makefiles-forever 2021-07-23 15:51:26 +02:00
Makefile fix: ignore _* files and dirs & manage image subfolders 2024-02-16 23:57:43 +01:00
Pipfile Bump debian and python versions 2024-02-01 14:12:24 +01:00
Pipfile.lock build(deps): bump pillow from 9.0.0 to 9.0.1 2022-03-12 01:09:45 +00:00
Procfile fix: ignore caddy for now 2024-02-16 23:58:29 +01:00
README.md doc: Update README 2023-01-16 12:36:18 +01:00
docker-compose.yml Update docker scripts 2021-11-23 23:46:50 +01:00
mkdocs-source.yml config: enable codehilite 2023-01-16 11:46:45 +01:00
package-lock.json Merge branch 'master' of github.com:glenux/teaching-boilerplate 2022-06-20 12:18:56 +02:00
package.json chore: update marp dependencies 2024-02-16 23:58:12 +01:00

README.md

DocMachine

Prerequisites

Make sure you have Docker installed.

Writing content

Create your directory tree

.           # project directory
|- docs     # where website documents go
|  `- *.md
|- slides   # where presentation documents go
|  `- *.md
|- images/  # where images go
|- ...

Content for docs

FIXME: tree structure

FIXME: autoslide feature

Content for slides

FIXME: tree structure

Watch mode

This mode allows you the result on-the-fly as you makea changes in the content.

To use watch mode, type:

docmachine -a watch

To use watch mode for slides only type:

docmachine -a watch-slides

To use watch mode for docs only type:

docmachine -a watch-docs

Build mode

This mode builds final content for delivery (website, PDF files)

Building HTML

To use build mode:

docmachine build

Building PDF