AsciiDoc (AsciiDoc)

Перейти к навигации Перейти к поиску
AsciiDoc
Расширение .adoc, .asciidoc, .txt
MIME-тип text/asciidoc, text/plain
Разработчик Стюарт Рэкхэм
Опубликован 2002; 22 года назад (2002)
Тип формата Язык разметки
Открытый формат? да
Сайт asciidoc.org

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: 
apt install имя-пакета
Материалы

Самые твёрдые материалы в природе:

  • фуллерит
  • лонсдейлит
  • алмаз

Примечания

[править | править код]
  1. ↑ Compare AsciiDoc to Markdown | Asciidoctor Docs. Дата обращения: 9 апреля 2023. Архивировано 6 апреля 2023 года.
  2. ↑ Markdown, Asciidoc, or reStructuredText — a tale of docs-as-code — Dewan’s Blog. Дата обращения: 9 апреля 2023. Архивировано 9 апреля 2023 года.
  3. ↑ AsciiDoc. Дата обращения: 18 октября 2013. Архивировано из оригинала 3 марта 2016 года.
  4. ↑ AsciiDoc Frequently Asked Questions. asciidoc.org. Дата обращения: 20 марта 2020. Архивировано 13 марта 2022 года.
  5. ↑ AsciiDoc Recommended Practices | Asciidoctor. asciidoctor.org. Дата обращения: 20 марта 2020. Архивировано 21 июня 2022 года.
  6. ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories. Дата обращения: 7 апреля 2023. Архивировано 1 ноября 2017 года.
  7. ↑ Asciidoc. GitLab User Docs. Дата обращения: 6 февраля 2020. Архивировано 22 июля 2019 года.
  8. ↑ Atlas Introduction. Author Welcome Kit. O'Reilly Media. Дата обращения: 19 мая 2016. Архивировано из оригинала 14 октября 2017 года.
  9. ↑ Git wiki. Git SCM. Дата обращения: 7 апреля 2023. Архивировано 16 августа 2021 года.
  10. ↑ AsciiDoc Working Group Charter. Дата обращения: 7 апреля 2023. Архивировано 8 февраля 2023 года.
  11. ↑ AsciiDoc Language. Дата обращения: 7 апреля 2023. Архивировано 19 июня 2021 года.

Ссылки

[править | править код]
Источник — https://ru.wikipedia.org/w/index.php?title=AsciiDoc&oldid=133039619