docmachine-containers/README.md

51 lines
751 B
Markdown
Raw Normal View History

2020-04-19 10:07:35 +00:00
# Teaching-Boilerplate
2018-04-20 15:27:59 +00:00
2022-01-25 15:06:04 +00:00
## Prerequisites :
2018-04-20 15:27:59 +00:00
2022-06-20 10:14:42 +00:00
Make sure you have docker installed
2018-04-20 15:27:59 +00:00
2022-06-20 10:14:42 +00:00
## Usage
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-06-20 10:14:42 +00:00
### Write content for docs
2021-07-21 11:58:16 +00:00
2022-06-20 10:14:42 +00:00
### Write content for slides
2021-07-21 11:58:16 +00:00
2020-04-19 10:07:35 +00:00
### 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