AsciiDoc
 | Эта статья нуждается в дополнительных цитатах для проверки . ( март 2014 г. ) |
| Расширения имен файлов |
.adoc, .asciidoc, .txt |
|---|---|
| Тип интернет-СМИ |
текст/asciidoc, текст/обычный |
| Первоначальный выпуск | 2002 год |
| Открытый формат ? | да |
| Веб-сайт | асцидок |
| Оригинальный автор(ы) | Стюарт Рэкхэм |
|---|---|
| Разработчик(и) | Мэтью Певелер, Дэн Аллен, Мишель Кремер и др. |
| Первоначальный выпуск | 25 ноября 2002 г |
| Стабильная версия | 10.2.0 [1] 
/ 22 мая 2022 г. |
| Репозиторий | github |
| Написано в | Питон |
| Операционная система | Кросс-платформенный |
| Тип | Генератор документации |
| Лицензия | Лицензия GPL v2 |
| Веб-сайт | asciidoc-py |
| Оригинальный автор(ы) | Райан Уолдрон |
|---|---|
| Разработчик(и) | Дэн Аллен, Сара Уайт и др. |
| Первоначальный выпуск | 30 января 2013 г |
| Стабильная версия | 2.0.23 [2]
/ 17 мая 2024 г. |
| Репозиторий | github |
| Написано в | Руби |
| Операционная система | Кросс-платформенный |
| Тип | Генератор документации |
| Лицензия | С |
| Веб-сайт | врач-ассистент |
AsciiDoc — это удобочитаемый формат документа, семантически эквивалентный DocBook XML , но использующий простого текста соглашения о разметке . Документы AsciiDoc можно создавать с помощью любого текстового редактора и читать «как есть» или отображать в HTML или любом другом формате, поддерживаемом цепочкой инструментов DocBook, например PDF , TeX , Unix man-страницы , электронные книги , слайд-презентации и т. д. [3] Общие расширения файлов AsciiDoc: txt (по рекомендации создателя AsciiDoc) и adoc. [4] [5]
История [ править ]
AsciiDoc был создан в 2002 году Стюартом Рэкхэмом , опубликовавшим инструменты («asciidoc» и «a2x»), написанные на языке программирования Python для преобразования простых текстовых, «читаемых человеком» файлов в широко используемые форматы опубликованных документов. [3]
Аскидоктор [ править ]
Реализация Ruby под названием Asciidoctor, выпущенная в 2013 году, используется GitHub. [6] и ГитЛаб . [7] Эта реализация также доступна в экосистеме Java с использованием JRuby и в экосистеме JavaScript с использованием Opal.js.
Некоторые книги и электронные книги O'Reilly Media написаны с использованием разметки AsciiDoc. [8]
Большая часть документации проекта Git написана в AsciiDoc. [9]
Формат AsciiDoc в настоящее время находится на стадии стандартизации Eclipse Foundation . [10] [11]
Пример [ править ]
Ниже показан текст с использованием разметки AsciiDoc и визуализация, аналогичная той, которая создается процессором AsciiDoc:
| Исходный текст AsciiDoc |
|---|
= My Article
J. Smith
https://wikipedia.org[Wikipedia] is an
on-line encyclopedia, available in
English and *many* other languages.
== Software
You can install 'package-name' using
the `gem` command:
gem install package-name
== Hardware
Metals commonly used include:
* copper
* tin
* lead
|
| HTML-рендеринг результата |
|---|
|
Дж. Смит Arc.Ask3.Ru – это электронная энциклопедия, доступен на английском и многих других языках. Вы можете установить имя_пакета, используя команду gem команда: gem install package-name Обычно используемые металлы включают:
|
Инструменты [ править ]
- Antora — генератор сайтов документации с несколькими репозиториями для технических писателей, использующих git .
- AsciiBinder – (устарела) система документации, построенная на Asciidoctor для людей, которым нужно поддерживать и переиздавать множество документов на регулярной основе.
- awestruct — генератор статических сайтов, вдохновленный Jekyll .
- Asciidoc FX – редактор книг AsciiDoc на основе JavaFX 8.
- AsciiDocLIVE – AsciiDocLIVE – бесплатный онлайн-редактор AsciiDoc.
- DAPS — DocBook Authoring and Publishing Suite (DAPS) — это программное обеспечение командной строки для публикации DocBook и AsciiDoc в форматах HTML, PDF и EPUB.
См. также [ править ]
Ссылки [ править ]
- ^ «Выпуск 10.2.0» . 22 мая 2022 г. Проверено 2 октября 2022 г.
- ^ «Выпуск 2.0.23» . 17 мая 2024 г. Проверено 20 мая 2024 г.
- ↑ Перейти обратно: Перейти обратно: а б «АскииДок» . Архивировано из оригинала 3 марта 2016 г. Проверено 18 октября 2013 г.
- ^ «Часто задаваемые вопросы по AsciiDoc» . asciidoc.org . Проверено 20 марта 2020 г.
- ^ «Рекомендуемые практики AsciiDoc | Asciidoctor» . asciidoctor.org . Проверено 20 марта 2020 г.
- ^ «AsciiDoc на базе Asciidoctor возвращается на GitHub и в его более 5 миллионов репозиториев» .
- ^ «Аскиидок» . Документы пользователя GitLab . Архивировано из оригинала 22 июля 2019 г. Проверено 6 февраля 2020 г.
- ^ «AsciiDoc 101 (глава 4 руководства «Начало работы с Atlas»)» . Приветственный набор автора . О'Рейли Медиа. Архивировано из оригинала 14 октября 2017 года . Проверено 19 мая 2016 г.
- ^ «Гит вики» . Гит СКМ.
- ^ «Язык AsciiDoc» . 27 июля 2020 г.
- ^ «Устав рабочей группы AsciiDoc» .
Внешние ссылки [ править ]
- Официальный сайт
- https://asciidoctor.org/
- Использование AsciiDoc и Asciidoctor для написания документации — Учебное пособие по AsciiDoc