🟢 | Docker images for use with docmachine-cli
Introduces distinct Dockerfiles for documentation and slide projects, enhancing modularity and build efficiency. The previous monolithic structure was less flexible and caused longer build times. - Added `DOCMACHINE_DOCS_ENABLE` and `DOCMACHINE_SLIDES_ENABLE` env variables to toggle features. - Created `docker/Dockerfile.docs` for documentation builds, including necessary tools and dependencies. - Created `docker/Dockerfile.slides` for slide builds to streamline setup. - Updated main Dockerfile to include `python-is-python3` for compatibility, removing redundant symlinks. - Enhanced LaTeX tools by adding `texlive-xetex` and extra fonts for improved PDF output. |
||
---|---|---|
.github/workflows | ||
.makefiles@d5627404e1 | ||
.marp | ||
docker | ||
docs | ||
docs.extra | ||
images | ||
scripts | ||
slides | ||
tasks | ||
utils/docs | ||
.dockerignore | ||
.drone.yml | ||
.gitignore | ||
.gitmodules | ||
caddy.conf | ||
docker-compose.yml | ||
Makefile | ||
mkdocs-source.yml | ||
overlay.sh | ||
package-lock.json | ||
package.json | ||
Pipfile | ||
Pipfile.lock | ||
Procfile | ||
README.md |
ℹ️ 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
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