Русская Википедия:AsciiDoc
AsciiDoc — человекочитаемый язык разметки обычного текста, созданный как простая альтернатива XML-формату DocBook. По сравнению с Markdown обеспечивает лучшую поддержку сложных таблиц, замечаний, перекрёстных ссылок, встроенного YouTube-видео[1]Шаблон:Аффилированный источник[2]Шаблон:Неавторитетный источник, позволяя без включений HTML-разметки и JavaScript-кода оформлять сложную документацию. Файлы AsciiDoc можно создавать с помощью любого текстового редактора, а для чтения не нужны никакие другие инструменты — разметка AsciiDoc интуитивно понятна обычному человеку, поскольку опирается на исторически сложившуюся практику оформления текста в электронных письмах и подобных документах.
AsciiDoc часто используют для создания документации, автоматически конвертируя генератором его перед публикацией в более популярные форматы, такие как HTML, PDF, TeX, справочные страницы Unix, электронные книги[3].
Распространёнными расширениями файлов AsciiDoc являются txt (как рекомендуется создателем AsciiDoc) и adoc[4][5].
Создан в 2002 году Стюартом Рэкхэмом для использования с написанными им на языке программирования Python инструментами — asciidoc, конвертирующим документы в форматы HTML и DocBook, и a2x, переводящим AsciiDoc-тексты в формат справочных страниц Unix. В 2013 году был выпущен конвертер Asciidoctor, который широко используется на GitHub[6] и GitLab[7]. Эта реализация также доступна в экосистеме Java с использованием JRuby и в экосистеме JavaScript с использованием Opal.js.
Среди применяющих формат — издательство O’Reilly[8] (в системе Atlas для создания и публикации книг) и проект Git (большая часть документации пишется на AsciiDoc[9]).
Формат проходит процедуру стандартизации в Eclipse Foundation[10][11]. AsciiDoc® и AsciiDoc Language™ являются зарегистрированными торговыми марками Eclipse Foundation.
Пример
Текст с использованием разметки AsciiDoc и его визуализация, аналогичная той, которая создаётся процессором AsciiDoc:
| Исходный текст AsciiDoc |
|---|
= Моя статья
В. Пупкин
https://wikipedia.org[Википедия] — это
онлайн-энциклопедия, доступная на русском
и *многих* других языках.
== Программное обеспечение
Вы можете установить 'имя пакета',
используя команду `apt`:
----
apt install имя-пакета
----
== Материалы
Самые твёрдые материалы в природе:
* фуллерит
* лонсдейлит
* алмаз
|
| HTML-визуализация разметки |
|---|
В. Пупкин
Википедия — это онлайн-энциклопедия, apt install имя-пакета Самые твёрдые материалы в природе:
|
Примечания
Ссылки
- Шаблон:Официальный сайт
- Using AsciiDoc and Asciidoctor to write documentation — руководство по созданию документации с помощью AsciiDoc и Asciidoctor
- asciidoclive.com — бесплатный онлайн-редактор AsciiDoc
Шаблон:Языки разметки документов
