RCEO-AIOS-Public-Tools-DocMaker Container

This container is part of the AIOS-Public project and provides a comprehensive documentation generation environment.

Overview

The RCEO-AIOS-Public-Tools-DocMaker container is designed for documentation generation tasks. It includes a wide range of tools for creating, converting, and processing documentation in various formats.

Tools Included

Core Tools

Base OS: Debian Bookworm slim
Shell: Bash
Programming Languages:
- Python 3
- Node.js
- Rust (with Cargo)

Documentation Generation

Pandoc: Universal document converter
mdBook: Create books from Markdown files
mdbook-pdf: PDF renderer for mdBook
Typst: Modern typesetting system
Marp CLI: Create presentations from Markdown

LaTeX

TeX Live Full: Complete LaTeX distribution for advanced document typesetting

Spell and Grammar Checking

Hunspell: Spell checker (with en-US dictionary)
Aspell: Spell checker (with en dictionary)
Vale: Syntax-aware linter for prose

Text Analysis

mdstat: Text statistics including reading time estimation

Usage

Building the container

# From the Docker directory
cd /home/localuser/AIWorkspace/AIOS-Public/Docker
docker-compose build docmaker

Running the container

# Start an interactive session
docker-compose run docmaker

# Run a specific command
docker-compose run docmaker [command]

# Example: Convert a Markdown file to PDF using pandoc
docker-compose run docmaker pandoc input.md -o output.pdf

# Example: Check spelling in a document
docker-compose run docmaker hunspell -d en_US document.md

# Example: Generate reading time statistics
docker-compose run docmaker python3 -m mdstat document.md

Using with docker-compose

# Build and start the container in one command
docker-compose up --build

# Start without rebuilding
docker-compose up

Volumes

The container maps:

Project root (/home/localuser/AIWorkspace/AIOS-Public) to /workspace inside the container (mapped as ../../ from the container directory)

Purpose

This container should be used for projects that need to generate finished documentation in various formats (PDF, HTML, presentations, etc.) with integrated spell/grammar checking and reading time estimation.

2.3 KiB Raw Blame History