# 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
[](https://pypi.org/project/asciidoc-dita-toolkit/)
[](https://github.com/rolfedh/asciidoc-dita-toolkit/pkgs/container/asciidoc-dita-toolkit-prod)
[](https://www.python.org/downloads/)
[](https://opensource.org/licenses/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)
```sh
# Install
pip install asciidoc-dita-toolkit
# Use
adt --help
adt --list-plugins
```
### Option 2: Container
```sh
# 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
```sh
# 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](docs/TROUBLESHOOTING.md) 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
- **Documentation**: https://rolfedh.github.io/asciidoc-dita-toolkit/
- **Issues**: https://github.com/rolfedh/asciidoc-dita-toolkit/issues
- **Contributing Guide**: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)
- **Troubleshooting**: [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)
## 📄 License
MIT License - see [LICENSE](LICENSE) file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "asciidoc-dita-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "rolfedh <rolfedh@users.noreply.github.com>",
"keywords": "asciidoc, dita, documentation, technical-writing, content-validation",
"author": null,
"author_email": "rolfedh <rolfedh@users.noreply.github.com>",
"download_url": "https://files.pythonhosted.org/packages/b1/f3/4b6152bce4c6f0adc82aa25fd2c09207e065f61da24ad349f6dc2cf0ace3/asciidoc_dita_toolkit-2.1.5.tar.gz",
"platform": null,
"description": "# AsciiDoc DITA Tool\n\n**\ud83d\udc49 Complete documentation and tutorials:** https://rolfedh.github.io/asciidoc-dita-toolkit/\n## \ud83d\udccb Prerequisites\n\n### Option 1: Python Package\n- **Python 3.8+** - Required for the package installation (we recommend upgrading to Python 3.8+)\n- **pip** - Python package manager\n- *Note: If you're using Python 3.7, please use the container option below*\n\n### Option 2: Container\n- **Docker** or **Podman** - Container runtime\n- **curl** - For downloading the wrapper script\n- *Recommended for users on Python 3.7 or those who prefer containerized tools*\n\n## \ud83d\ude80 Quick Start\n\n[](https://pypi.org/project/asciidoc-dita-toolkit/)\n[](https://github.com/rolfedh/asciidoc-dita-toolkit/pkgs/container/asciidoc-dita-toolkit-prod)\n[](https://www.python.org/downloads/)\n[](https://opensource.org/licenses/MIT)\n\nA command-line toolkit for technical writers to review and fix AsciiDoc content for DITA-based publishing workflows.\n\n## What is this?\n\nThe AsciiDoc DITA Toolkit helps you:\n\n- **Find and fix** common issues in `.adoc` files before publishing\n- **Apply automated checks** and transformations using a plugin system\n- **Ensure consistency** across large documentation projects\n- **Integrate** with your existing documentation workflow\n\n## \ufffd Documentation\n\n**\ud83d\udc49 Complete documentation and tutorials:** https://rolfedh.github.io/asciidoc-dita-toolkit/\n\n## \ud83d\ude80 Quick Start\n\n### Option 1: Python Package (Recommended)\n\n```sh\n# Install\npip install asciidoc-dita-toolkit\n\n# Use\nadt --help\nadt --list-plugins\n```\n\n### Option 2: Container\n\n```sh\n# One-time setup: Download and install adt wrapper\ncurl -sSL https://raw.githubusercontent.com/rolfedh/asciidoc-dita-toolkit/main/scripts/adt-docker -o /usr/local/bin/adt && chmod +x /usr/local/bin/adt\n\n# Use\nadt --help\nadt --list-plugins\n```\n\n## \ufffd Basic Usage\n\n```sh\n# Fix HTML entity references\nadt EntityReference -r\n\n# Add content type labels\nadt ContentType -r\n```\n\n## \ud83d\udee0\ufe0f Troubleshooting\n\nIf you encounter issues like \"Failed to load module\" or \"No module named 'modules'\" errors, see our [Troubleshooting Guide](docs/TROUBLESHOOTING.md) for solutions.\n\nCommon fixes:\n- Remove conflicting packages: `pip uninstall adt-core`\n- Clear package cache: `pip cache purge`\n- Reinstall: `pip install --upgrade asciidoc-dita-toolkit`\n\n## \ud83e\udd1d Contributing\n\n- **Documentation**: https://rolfedh.github.io/asciidoc-dita-toolkit/\n- **Issues**: https://github.com/rolfedh/asciidoc-dita-toolkit/issues\n- **Contributing Guide**: [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)\n- **Troubleshooting**: [docs/TROUBLESHOOTING.md](docs/TROUBLESHOOTING.md)\n\n## \ud83d\udcc4 License\n\nMIT License - see [LICENSE](LICENSE) file for details.\n",
"bugtrack_url": null,
"license": null,
"summary": "AsciiDoc DITA Toolkit - unified package for technical documentation workflows",
"version": "2.1.5",
"project_urls": {
"Bug Reports": "https://github.com/rolfedh/asciidoc-dita-toolkit/issues",
"Documentation": "https://github.com/rolfedh/asciidoc-dita-toolkit/blob/main/docs/",
"Homepage": "https://github.com/rolfedh/asciidoc-dita-toolkit",
"Source": "https://github.com/rolfedh/asciidoc-dita-toolkit"
},
"split_keywords": [
"asciidoc",
" dita",
" documentation",
" technical-writing",
" content-validation"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "402fd99fa628d27791487218ed5c507d771ba992eab680bf59de319f9ea32919",
"md5": "72ac6ac583bec86bb7c02f4af78f0ee8",
"sha256": "d145a367dacc53413d05a8455ace0b6e2d8eb3cad5a03af6f3039a37024c1932"
},
"downloads": -1,
"filename": "asciidoc_dita_toolkit-2.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "72ac6ac583bec86bb7c02f4af78f0ee8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 114310,
"upload_time": "2025-07-26T01:35:52",
"upload_time_iso_8601": "2025-07-26T01:35:52.826492Z",
"url": "https://files.pythonhosted.org/packages/40/2f/d99fa628d27791487218ed5c507d771ba992eab680bf59de319f9ea32919/asciidoc_dita_toolkit-2.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b1f34b6152bce4c6f0adc82aa25fd2c09207e065f61da24ad349f6dc2cf0ace3",
"md5": "c1ed06be9da563af1dde0f4ef155730c",
"sha256": "751a7294c98932063903f457d7885f4add9c6b5348ef5db461b620088e9dee1f"
},
"downloads": -1,
"filename": "asciidoc_dita_toolkit-2.1.5.tar.gz",
"has_sig": false,
"md5_digest": "c1ed06be9da563af1dde0f4ef155730c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 309616,
"upload_time": "2025-07-26T01:35:54",
"upload_time_iso_8601": "2025-07-26T01:35:54.210857Z",
"url": "https://files.pythonhosted.org/packages/b1/f3/4b6152bce4c6f0adc82aa25fd2c09207e065f61da24ad349f6dc2cf0ace3/asciidoc_dita_toolkit-2.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-26 01:35:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rolfedh",
"github_project": "asciidoc-dita-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "asciidoc-dita-toolkit"
}
JSON
