2024-06-02 07:11:52 +00:00
|
|
|
<!--
|
|
|
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
|
#
|
|
|
|
|
# SPDX-FileCopyrightText: 2023 Glenn Y. Rolland <glenux@glenux.net>
|
|
|
|
|
# Copyright © 2023 Glenn Y. Rolland <glenux@glenux.net>
|
|
|
|
|
-->
|
|
|
|
|
|
|
|
|
|
[](https://cicd.apps.glenux.net/glenux/docmachine-containers)
|
|
|
|
|
|
|
|
|
|
[](https://patreon.com/glenux)
|
|
|
|
|
|
|
|
|
|
> :information_source: This project is available on our self-hosted server and
|
|
|
|
|
> on CodeBerg and GitHub as mirrors. For the latest updates and comprehensive
|
|
|
|
|
> version of our project, please visit our primary repository at:
|
|
|
|
|
> <https://code.apps.glenux.net/glenux/docmachine-containers>.
|
|
|
|
|
|
|
|
|
|
# DocMachine Containers
|
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:
|
|
|
|
|
|
2023-01-16 11:36:18 +00:00
|
|
|
docmachine -a watch
|
2020-04-19 10:07:35 +00:00
|
|
|
|
|
|
|
|
To use watch mode for slides only type:
|
|
|
|
|
|
2023-01-16 11:36:18 +00:00
|
|
|
docmachine -a watch-slides
|
2020-04-19 10:07:35 +00:00
|
|
|
|
|
|
|
|
To use watch mode for docs only type:
|
|
|
|
|
|
2023-01-16 11:36:18 +00:00
|
|
|
docmachine -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:
|
|
|
|
|
|
2023-01-16 11:36:18 +00:00
|
|
|
docmachine build
|
2022-08-18 09:14:02 +00:00
|
|
|
|
|
|
|
|
### Building PDF
|
|
|
|
|
|
|
|
|
|
|
