Interested Article - AsciiDoc


- 2020-03-11
- 1
AsciiDoc — человекочитаемый язык разметки обычного текста , созданный как простая альтернатива XML -формату DocBook . По сравнению с Markdown обеспечивает лучшую поддержку сложных таблиц, замечаний, перекрёстных ссылок, встроенного YouTube-видео [ аффилированный источник? ] [ неавторитетный источник ] , позволяя без включений HTML-разметки и JavaScript-кода оформлять сложную документацию. Файлы AsciiDoc можно создавать с помощью любого текстового редактора , а для чтения не нужны никакие другие инструменты — разметка AsciiDoc интуитивно понятна обычному человеку, поскольку опирается на исторически сложившуюся практику оформления текста в электронных письмах и подобных документах.
AsciiDoc часто используют для создания документации, автоматически конвертируя генератором его перед публикацией в более популярные форматы, такие как HTML , PDF , TeX , справочные страницы Unix , электронные книги .
Распространёнными расширениями файлов AsciiDoc являются txt (как рекомендуется создателем AsciiDoc) и adoc .
Создан в 2002 году для использования с написанными им на языке программирования Python инструментами — asciidoc, конвертирующим документы в форматы HTML и DocBook, и a2x, переводящим AsciiDoc-тексты в формат справочных страниц Unix. В 2013 году был выпущен конвертер Asciidoctor, который широко используется на GitHub и GitLab . Эта реализация также доступна в экосистеме Java с использованием JRuby и в экосистеме JavaScript с использованием Opal.js.
Среди применяющих формат — издательство O’Reilly (в системе Atlas для создания и публикации книг) и проект Git (большая часть документации пишется на AsciiDoc ).
Формат проходит процедуру стандартизации в Eclipse Foundation . AsciiDoc® и AsciiDoc Language™ являются зарегистрированными торговыми марками Eclipse Foundation .
Пример
Текст с использованием разметки AsciiDoc и его визуализация, аналогичная той, которая создаётся процессором AsciiDoc:
Исходный текст AsciiDoc |
---|
= Моя статья
В. Пупкин
https://wikipedia.org[Википедия] — это
онлайн-энциклопедия, доступная на русском
и *многих* других языках.
== Программное обеспечение
Вы можете установить 'имя пакета',
используя команду `apt`:
----
apt install имя-пакета
----
== Материалы
Самые твёрдые материалы в природе:
* фуллерит
* лонсдейлит
* алмаз
|
HTML-визуализация разметки |
---|
— это онлайн-энциклопедия,
apt install имя-пакета Самые твёрдые материалы в природе:
|
Примечания
- . Дата обращения: 9 апреля 2023. 6 апреля 2023 года.
- . Дата обращения: 9 апреля 2023. 9 апреля 2023 года.
- . Дата обращения: 18 октября 2013. Архивировано из 3 марта 2016 года.
- . asciidoc.org . Дата обращения: 20 марта 2020. 13 марта 2022 года.
- . asciidoctor.org . Дата обращения: 20 марта 2020. 21 июня 2022 года.
- . Дата обращения: 7 апреля 2023. 1 ноября 2017 года.
- . GitLab User Docs . Дата обращения: 6 февраля 2020. 22 июля 2019 года.
- . Author Welcome Kit . O'Reilly Media. Дата обращения: 19 мая 2016. Архивировано из 14 октября 2017 года.
- . Git SCM. Дата обращения: 7 апреля 2023. 16 августа 2021 года.
- . Дата обращения: 7 апреля 2023. 8 февраля 2023 года.
- . Дата обращения: 7 апреля 2023. 19 июня 2021 года.
Ссылки
- — официальный сайт AsciiDoc
- — руководство по созданию документации с помощью AsciiDoc и Asciidoctor
- — бесплатный онлайн-редактор AsciiDoc

- 2020-03-11
- 1