You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
continuous-integration/drone/push Build is passing
Details
|
2 months ago | |
---|---|---|
.github/workflows | 1 year ago | |
.makefiles@d5627404e1 | 2 years ago | |
.marp | 12 months ago | |
docker | 5 months ago | |
docs | 2 years ago | |
docs.extra | 7 months ago | |
images | 2 years ago | |
scripts | 5 months ago | |
slides | 2 years ago | |
.dockerignore | 5 months ago | |
.drone.yml | 5 months ago | |
.gitignore | 2 years ago | |
.gitmodules | 2 years ago | |
Makefile | 2 months ago | |
Pipfile | 1 year ago | |
Pipfile.lock | 1 year ago | |
Procfile | 12 months ago | |
README.md | 5 months ago | |
docker-compose.yml | 2 years ago | |
mkdocs-source.yml | 5 months ago | |
package-lock.json | 12 months ago | |
package.json | 1 year 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