glenux/docmachine
glenux/docmachine
1
0
Fork 0
Code Issues Pull requests Packages Projects 1 Releases Wiki Activity

doc: Update doc structure

Browse source
This commit is contained in:
Glenn Y. Rolland 2022-08-18 11:14:02 +02:00
parent d6844f9a31
commit f6b8e5d1f6
1 changed files with 22 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
README.md
View file

@ -1,10 +1,10 @@
# Teaching-Boilerplate
# GX-Teaching
## Prerequisites :
## Prerequisites
Make sure you have docker installed
Make sure you have Docker installed.
## Usage
## Writing content
### Create your directory tree
@ -18,33 +18,43 @@ Make sure you have docker installed
|- ...
```
### Write content for docs
### Content for docs
FIXME: tree structure
### Write content for slides
FIXME: autoslide feature
### Content for slides
### Watch mode
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:
make watch
gx-teaching -a watch
To use watch mode for slides only type:
make watch-slides
gx-teaching -a watch-slides
To use watch mode for docs only type:
make watch-docs
gx-teaching -a watch-docs
### Build mode
## Build mode
This mode builds final content for delivery (website, PDF files)
### Building HTML
To use build mode:
make build
gx-teaching build
### Building PDF