Из Википедии, бесплатной энциклопедии
Перейти к навигации Перейти к поиску
AsciiDoc
изначальный выпуск2002 ; 19 лет назад ( 2002 )
Открытый формат ?да
Интернет сайтasciidoc .org Отредактируйте это в Викиданных
AsciiDoc
Автор (ы) оригиналаСтюарт Рэкхэм
Разработчики)Мэтью Певелер, Дэн Аллен, Мишель Кремер и др.
изначальный выпуск25 ноября 2002 г . ; 18 лет назад ( 2002-11-25 )
Стабильный выпуск
9.0.5 / 24 января 2021 г . ; 57 дней назад ( 2021-01-24 )
Репозиторийgithub .com / asciidoc / asciidoc-py3
Написано вPython
Операционная системаКроссплатформенность
ТипГенератор документации
ЛицензияGPL v2
Интернет сайтasciidoc .org
Asciidoctor
Автор (ы) оригиналаРайан Уолдрон
Разработчики)Дэн Аллен, Сара Уайт и др.
изначальный выпуск30 января 2013 г . ; 8 лет назад ( 30.01.2013 )
Стабильный выпуск
2.0.12 / 9 ноября 2020 г . ; 4 месяца назад ( 2020-11-09 )
Репозиторийgithub .com / asciidoctor / asciidoctor
Написано вРубин
Операционная системаКроссплатформенность
ТипГенератор документации
ЛицензияМассачусетский технологический институт
Интернет сайтasciidoctor .org

AsciiDoc является человеком-читаемый формат документа, семантически эквивалентно DocBook XML , но с использованием обычного текста наценка конвенции. Документы AsciiDoc могут быть созданы с помощью любого текстового редактора и прочитаны «как есть», либо преобразованы в HTML или любой другой формат, поддерживаемый цепочкой инструментов DocBook, например, PDF , TeX , страницы руководства Unix , электронные книги , слайд-презентации и т. Д. [1] Распространенными расширениями файлов для файлов AsciiDoc являются (как рекомендовано создателем AsciiDoc) и . [2] [3]txtadoc

История [ править ]

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

Рубин реализация называется «Asciidoctor», выпущенный в 2013 году, уже используется 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 [Википедия] - этоон-лайн энциклопедия, доступная наАнглийский и многие другие языки.== Программное обеспечениеВы можете установить 'package-name', используякоманда `gem` : gem install имя-пакета== ОборудованиеОбычно используемые металлы включают:* медь * олово * свинец
HTML-результат
Моя статья

Дж. Смит

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

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

Вы можете установить package-name с помощью gemкоманды:

gem install имя-пакета
Аппаратное обеспечение

Обычно используемые металлы включают:

  • медь
  • банка
  • вести

Инструменты [ править ]

  • Antora - генератор сайтов документации с несколькими репозиториями для технических писателей, использующих git .
  • AsciiBinder - (устарело) система документации, построенная на Asciidoctor для людей, у которых есть много документов, которые нужно поддерживать и переиздавать на регулярной основе.
  • awestruct - генератор статических сайтов, вдохновленный Джекилом .
  • Asciidoc FX - редактор книг AsciiDoc на основе JavaFX 8.
  • AsciiDocLIVE - AsciiDocLIVE - бесплатный онлайн-редактор AsciiDoc.

См. Также [ править ]

  • Сравнение генераторов документации
  • Легкий язык разметки

Ссылки [ править ]

  1. ^ a b "AsciiDoc" .
  2. ^ «Часто задаваемые вопросы по AsciiDoc» . asciidoc.org . Проверено 20 марта 2020 .
  3. ^ "Рекомендуемые методы работы с AsciiDoc | Asciidoctor" . asciidoctor.org . Проверено 20 марта 2020 .
  4. ^ «AsciiDoc, поддерживаемый Asciidoctor, возвращается на GitHub и его 5+ миллионов репозиториев» .
  5. ^ "Asciidoc" . Пользовательские документы GitLab . Проверено 6 фев 2020 .
  6. ^ «AsciiDoc 101 (глава 4 книги« Начало работы с Атласом »)» . Авторский приветственный набор . O'Reilly Media. Архивировано из оригинального 14 октября 2017 года . Дата обращения 19 мая 2016 .
  7. ^ "Git wiki" . Git SCM.
  8. ^ "Язык AsciiDoc" .
  9. ^ «Устав рабочей группы AsciiDoc» .

Внешние ссылки [ править ]

  • Официальный веб-сайт
  • https://asciidoctor.org/
  • Использование AsciiDoc и Asciidoctor для написания документации - Учебное пособие по AsciiDoc