Add Docker documentation tools container with pandoc, mdbook, typst, latex, spell checking, and reading time estimation
This commit is contained in:
38
Docker/README.md
Normal file
38
Docker/README.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# AIOS-Public Docker Documentation Tools
|
||||
|
||||
This directory contains Docker configurations for documentation generation tools in the AIOS-Public project.
|
||||
|
||||
## Container Structure
|
||||
|
||||
Each container has its own subdirectory with specific configuration files:
|
||||
|
||||
- `RCEO-AIOS-Public-Tools-DocMaker/` - Comprehensive documentation generation environment
|
||||
|
||||
## Available Containers
|
||||
|
||||
### RCEO-AIOS-Public-Tools-DocMaker
|
||||
A container with a full suite of documentation tools including:
|
||||
- Pandoc, mdBook, Typst, Marp for document conversion
|
||||
- LaTeX for typesetting
|
||||
- Spell/grammar checking tools (Hunspell, Aspell, Vale)
|
||||
- Reading time estimation (mdstat)
|
||||
- Programming languages (Python, Node.js, Rust)
|
||||
|
||||
## Usage
|
||||
|
||||
### Building and Running Individual Containers
|
||||
Each container has its own subdirectory with its Dockerfile and docker-compose.yml file.
|
||||
|
||||
```bash
|
||||
# Navigate to the specific container directory
|
||||
cd /home/localuser/AIWorkspace/AIOS-Public/Docker/RCEO-AIOS-Public-Tools-DocMaker
|
||||
|
||||
# Build the container
|
||||
docker-compose build
|
||||
|
||||
# Run the container
|
||||
docker-compose up --build
|
||||
```
|
||||
|
||||
### Individual Container Documentation
|
||||
For specific usage information for each container, see the README files in their respective subdirectories.
|
||||
Reference in New Issue
Block a user