docmachine-containers/README.md

61 lines
883 B
Markdown
Raw Normal View History

2022-08-18 09:14:02 +00:00
# GX-Teaching
2018-04-20 15:27:59 +00:00
2022-08-18 09:14:02 +00:00
## Prerequisites
2018-04-20 15:27:59 +00:00
2022-08-18 09:14:02 +00:00
Make sure you have Docker installed.
2018-04-20 15:27:59 +00:00
2022-08-18 09:14:02 +00:00
## Writing content
2018-04-20 15:27:59 +00:00
2022-06-20 10:14:42 +00:00
### Create your directory tree
2018-04-20 15:27:59 +00:00
2022-06-20 10:14:42 +00:00
```
. # project directory
|- docs # where website documents go
| `- *.md
|- slides # where presentation documents go
| `- *.md
|- images/ # where images go
|- ...
```
2020-04-19 10:07:35 +00:00
2022-08-18 09:14:02 +00:00
### Content for docs
2021-07-21 11:58:16 +00:00
2022-08-18 09:14:02 +00:00
FIXME: tree structure
2021-07-21 11:58:16 +00:00
2022-08-18 09:14:02 +00:00
FIXME: autoslide feature
2021-07-21 11:58:16 +00:00
2022-08-18 09:14:02 +00:00
### Content for slides
2021-07-21 11:58:16 +00:00
2022-08-18 09:14:02 +00:00
FIXME: tree structure
## Watch mode
2020-04-19 10:07:35 +00:00
This mode allows you the result on-the-fly as you makea changes in the content.
To use watch mode, type:
2022-08-18 09:14:02 +00:00
gx-teaching -a watch
2020-04-19 10:07:35 +00:00
To use watch mode for slides only type:
2022-08-18 09:14:02 +00:00
gx-teaching -a watch-slides
2020-04-19 10:07:35 +00:00
To use watch mode for docs only type:
2022-08-18 09:14:02 +00:00
gx-teaching -a watch-docs
2020-04-19 10:07:35 +00:00
2022-08-18 09:14:02 +00:00
## Build mode
2020-04-19 10:07:35 +00:00
This mode builds final content for delivery (website, PDF files)
2022-08-18 09:14:02 +00:00
### Building HTML
2020-04-19 10:07:35 +00:00
To use build mode:
2022-08-18 09:14:02 +00:00
gx-teaching build
### Building PDF