AsciiDoc

Материал из Википедии — свободной энциклопедии
Это старая версия этой страницы, сохранённая Kostenelo (обсуждение | вклад) в 00:40, 8 апреля 2023 (→Внешние ссылки). Она может серьёзно отличаться от текущей версии.
Перейти к навигации Перейти к поиску
AsciiDoc
Расширение .adoc, .asciidoc, .txt
MIME-тип text/asciidoc, text/plain
Разработчик Стюарт Рэкхэм
Опубликован 2002; 23 года назад (2002)
Тип формата Язык разметки
Открытый формат? да
Сайт asciidoc.org

AsciiDoc — это человекочитаемый язык разметки обычного текста, созданный как простая альтернатива XML формату DocBook. AsciiDoc напоминает другой простой язык разметки Markdown, выгодно отличаясь от него большей лаконичностью и гибкостью. Документы AsciiDoc можно создавать с помощью любого текстового редактора, а для чтения не нужны никакие другие инструменты - разметка AsciiDoc интуитивно понятна обычному человеку, поскольку опирается на исторически сложившуюся практику оформления текста в электронных письмах и подобных документах.

AsciiDoc часто используют для создания документации, автоматически конвертируя его перед публикацией в более популярные форматы, такие как HTML, PDF, TeX, справочные страницы Unix, электронные книги и т.п. [1]

Распространенными расширениями файлов AsciiDoc являются txt (как рекомендуется создателем AsciiDoc) и adoc.[2][3]

История

Простые языки разметки, такие как AsciiDoc, помогают быстро набирать на клавиатуре (в текстовом редакторе или даже в консоли) большие объёмы текста с простым форматированием. Перед передачей конечным пользователям документации эти текстовые файлы, размеченные условными символами форматирования, конвертируют в широко используемые форматы для публикации документов (такие как PDF, EPUB, HTML и т.п.).[1]

В 2002 году Стюартом Рэкхэмом в этой парадигме был разработан формат AsciiDoc для использования с написанными им на языке программирования Python инструментами («asciidoc» и «a2x»).

В 2013 году был выпущен конвертор Asciidoctor, кторый широко используется на GitHub[4] и GitLab.[5] Эта реализация также доступна в экосистеме Java с использованием JRuby и в экосистеме JavaScript с использованием Opal.js.

Некоторые книги и электронные книги O'Reilly Media созданы с использованием разметки AsciiDoc.[6]

Большая часть документации проекта Git написана на AsciiDoc. [7]

Формат AsciiDoc в настоящее время проходит процедуру стандартизации Eclipse Foundation.[8][9]

Пример разметки

Ниже показан текст с использованием разметки AsciiDoc и его визуализация, аналогичная той, которая создается процессором AsciiDoc:

Исходный текст AsciiDoc 
= Моя статья

В. Пупкин

https://wikipedia.org[Википедия] — это 
онлайн энциклопедия, доступная на английском 
и *многих* других языках.

== Программное обеспечение

Вы можете установить 'имя пакета', 
используя команду `gem`:

gem install имя-пакета

== Оборудование

Эти металлы использу.тся чаще всего:

*медь
*олово
*свинец
HTML-визуализация разметки
Моя статья
В. Пупкин

Википедия — это онлайн энциклопедия,
доступная на английском и многих других языках.

Программное обеспечение
Вы можете установить имя пакета, используя команду gem:

gem install имя-пакета

Оборудование

Эти металлы используются чаще всего:

  • медь
  • олово
  • свинец


Инструменты

  • Antora — генератор сайтов документации с несколькими репозиториями для технических писателей, использующий git.
  • AsciiBinder — (устаревшая) система документации, построенная на Asciidoctor, для людей, у которых есть много документов, которые нужно поддерживать и регулярно переиздавать.
  • awestruct — генератор статических сайтов, вдохновленный Jekyll.
  • Asciidoc FX — редактор книг AsciiDoc на основе JavaFX 8.
  • AsciiDocLIVE — AsciiDocLIVE — бесплатный онлайн-редактор AsciiDoc.
  • Asciidoctor[10] — текстовый процессор с открытым исходным кодом и конвертер AsciiDoc в форматы HTML 5, DocBook 5, Man страницы, PDF, EPUB 3 и др.

Смотрите также

Ссылки

  1. ↑ 1 2 AsciiDoc. Дата обращения: 18 октября 2013. Архивировано из оригинала 3 марта 2016 года.
  2. ↑ AsciiDoc Frequently Asked Questions. asciidoc.org. Дата обращения: 20 марта 2020.
  3. ↑ AsciiDoc Recommended Practices | Asciidoctor. asciidoctor.org. Дата обращения: 20 марта 2020.
  4. ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories.
  5. ↑ Asciidoc. GitLab User Docs. Дата обращения: 6 февраля 2020. Архивировано 22 июля 2019 года.
  6. ↑ AsciiDoc 101 (chapter 4 of Getting Started with Atlas). Author Welcome Kit. O'Reilly Media. Дата обращения: 19 мая 2016. Архивировано из оригинала 14 октября 2017 года.
  7. ↑ Git wiki. Git SCM.
  8. ↑ AsciiDoc Language.
  9. ↑ AsciiDoc Working Group Charter.
  10. ↑ https://asciidoctor.org/

Внешние ссылки

Источник — https://ru.wikipedia.org/w/index.php?title=AsciiDoc&oldid=129704204