You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Glenn Y. Rolland 434c3d72e0
continuous-integration/drone/push Build is passing Details
doc: Update README
3 weeks ago
.github/workflows ci: fix command in test job 1 year ago
.makefiles@d5627404e1 Update .makefiles 2 years ago
.marp feat: Add support for rows/colums in marp 8 months ago
docker fix: Force version number for node image 3 weeks ago
docs style: improve filesystem organization 2 years ago
docs.extra Add extra JS & CSS 3 months ago
images Add sample images for .dot and .circo 2 years ago
scripts brand: rename project 3 weeks ago
slides Add support for mdpp slides 2 years ago
.dockerignore fix: docker build must ignore drone file 3 weeks ago
.drone.yml ci: remove useless build step 3 weeks ago
.gitignore chore: ignore marp theme.css & sort ignored files 2 years ago
.gitmodules Add dependency to makefiles-forever 2 years ago
Makefile fix: Make sure autoslide is run before watch 3 weeks ago
Pipfile feat: add support for PDF generation from docs 1 year ago
Pipfile.lock build(deps): bump pillow from 9.0.0 to 9.0.1 11 months ago
Procfile feature: Add auto-generated deck 'autoslide' 8 months ago
README.md doc: Update README 3 weeks ago
docker-compose.yml Update docker scripts 1 year ago
mkdocs-source.yml config: enable codehilite 3 weeks ago
package-lock.json Merge branch 'master' of github.com:glenux/teaching-boilerplate 8 months ago
package.json build(deps): bump node-sass from 6.0.1 to 7.0.0 12 months ago

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