Skip to main content

AsciiDoc DITA Toolkit - unified package for technical documentation workflows

Project description

AsciiDoc DITA Tool

👉 Complete documentation and tutorials: https://rolfedh.github.io/asciidoc-dita-toolkit/

📋 Prerequisites

Option 1: Python Package

  • Python 3.8+ - Required for the package installation (we recommend upgrading to Python 3.8+)
  • pip - Python package manager
  • Note: If you're using Python 3.7, please use the container option below

Option 2: Container

  • Docker or Podman - Container runtime
  • curl - For downloading the wrapper script
  • Recommended for users on Python 3.7 or those who prefer containerized tools

🚀 Quick Start

PyPI version Container Python 3.8+ License: MIT

A command-line toolkit for technical writers to review and fix AsciiDoc content for DITA-based publishing workflows.

What is this?

The AsciiDoc DITA Toolkit helps you:

  • Find and fix common issues in .adoc files before publishing
  • Apply automated checks and transformations using a plugin system
  • Ensure consistency across large documentation projects
  • Integrate with your existing documentation workflow

� Documentation

👉 Complete documentation and tutorials: https://rolfedh.github.io/asciidoc-dita-toolkit/

🚀 Quick Start

Option 1: Python Package (Recommended)

# Install
pip install asciidoc-dita-toolkit

# Use
adt --help
adt --list-plugins

Option 2: Container

# One-time setup: Download and install adt wrapper
curl -sSL https://raw.githubusercontent.com/rolfedh/asciidoc-dita-toolkit/main/scripts/adt-docker -o /usr/local/bin/adt && chmod +x /usr/local/bin/adt

# Use
adt --help
adt --list-plugins

� Basic Usage

# Fix HTML entity references
adt EntityReference -r

# Add content type labels
adt ContentType -r

🛠️ Troubleshooting

If you encounter issues like "Failed to load module" or "No module named 'modules'" errors, see our Troubleshooting Guide for solutions.

Common fixes:

  • Remove conflicting packages: pip uninstall adt-core
  • Clear package cache: pip cache purge
  • Reinstall: pip install --upgrade asciidoc-dita-toolkit

🤝 Contributing

📄 License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

asciidoc_dita_toolkit-2.1.5.tar.gz (309.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

asciidoc_dita_toolkit-2.1.5-py3-none-any.whl (114.3 kB view details)

Uploaded Python 3

File details

Details for the file asciidoc_dita_toolkit-2.1.5.tar.gz.

File metadata

  • Download URL: asciidoc_dita_toolkit-2.1.5.tar.gz
  • Upload date:
  • Size: 309.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.13

File hashes

Hashes for asciidoc_dita_toolkit-2.1.5.tar.gz
Algorithm Hash digest
SHA256 751a7294c98932063903f457d7885f4add9c6b5348ef5db461b620088e9dee1f
MD5 c1ed06be9da563af1dde0f4ef155730c
BLAKE2b-256 b1f34b6152bce4c6f0adc82aa25fd2c09207e065f61da24ad349f6dc2cf0ace3

See more details on using hashes here.

File details

Details for the file asciidoc_dita_toolkit-2.1.5-py3-none-any.whl.

File metadata

File hashes

Hashes for asciidoc_dita_toolkit-2.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d145a367dacc53413d05a8455ace0b6e2d8eb3cad5a03af6f3039a37024c1932
MD5 72ac6ac583bec86bb7c02f4af78f0ee8
BLAKE2b-256 402fd99fa628d27791487218ed5c507d771ba992eab680bf59de319f9ea32919

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page