AsciiDoc — человеко-читаемый текстовый маркировочный язык и связанная с ним экосистема инструментов для подготовки технической документации и публикаций. Язык предназначен для описания структурированного контента: заголовков, списков, таблиц, примеров кода, примечаний и метаданных, с последующей генерацией в форматы, пригодные для распространения и печати. Формат ориентирован на удобство написания и чтения в исходном виде, а также на автоматическую трансформацию в HTML, PDF, EPUB, ман-страницы и другие целевые форматы с сохранением семантики документа.
Разработка и распространение инструментов AsciiDoc эволюционировали в несколько реализаций и конвертеров, обеспечивающих совместимость с различными экосистемами сборки документации. AsciiDoc применяется для технических руководств, руководств по API, внутренних вики и публикаций, где важны повторяемая сборка, управление версиями и возможность интеграции с системами непрерывной интеграции. Язык сочетает простоту синтаксиса похожую на разметку в простом тексте с богатой семантикой, поддерживающей стилизацию, перекрёстные ссылки и вставку блоков с метаданными.
- Читаемость: человеко-читаемая плоская текстовая синтаксическая модель, удобная для редактирования в любом текстовом редакторе.
- Многоплатформенность вывода: возможность генерации HTML, PDF, EPUB, man-страниц и других форматов через различные конвертеры.
- Структурированные элементы: заголовки, списки, блоки кода, цитаты, примечания, таблицы и примеры с сохранением семантики при конвертации.
- Метаданные и атрибуты: поддержка атрибутов документа, включений файлов и условной генерации контента.
- Интеграция в рабочие процессы: совместимость с системами контроля версий, инструментами сборки и CI/CD для автоматической сборки документации.
- Расширяемость: возможности кастомизации шаблонов и фильтров в конвертерах для получения требуемого визуального оформления и структуры выходных файлов.
- Управление разделами и ссылками: семантические ссылки, якоря и перекрёстные ссылки внутри документации.
- Поддержка многофайловых проектов: включение и объединение отдельных файлов в единый собранный документ.