AsciiDoc
| Розширення файлу: |
.txt[1], .adoc або .asciidoc |
|---|---|
| MIME-тип: | text/asciidoc |
AsciiDoc — людиночитанна[de] мова розмітки звичайного тексту, створена як проста альтернатива XML-формату DocBook. Порівняно з Markdown, забезпечує кращу підтримку складних таблиць, зауважень, перехресних посилань, вбудованого YouTube-відео[2][3][неавторитетне джерело], дозволяючи без включень розмітки HTML та коду JavaScript оформлювати складні документи. Файли AsciiDoc можна створювати за допомогою будь-якого текстового редактора, а для читання не потрібні ніякі інші інструменти — розмітка AsciiDoc інтуїтивно зрозуміла людині, оскільки спирається на усталену практику оформлення тексту в електронних листах і подібних документах.
AsciiDoc часто використовують для створення документації, перед опублікуванням автоматично конвертуючи генератором у популярніші формати, такі як HTML, PDF, TeX, довідкові сторінки Unix, електронні книги[4].
Поширеними розширеннями файлів AsciiDoc є txt (як рекомендує творець AsciiDoc) та adoc[5][6].
Створив 2002 року Стюарт Рекхем для використання з інструментами, які він написав мовою програмування Python, — asciidoc, що конвертує документи у формати HTML та DocBook, та a2x, що переводить AsciiDoc-тексти у формат довідкових сторінок Unix. 2013 року випущено конвертер Asciidoctor, який широко використовується на GitHub[7] та GitLab[8]. Ця реалізація також доступна в екосистемі Java з використанням JRuby та в екосистемі JavaScript з використанням Opal.js.
Формат застосовують видавництво O'Reilly[9] (у системі Atlas для створення та публікування книг) та проєкт Git (більшість документації пишеться на AsciiDoc[10]).
Формат проходить процедуру стандартизації в Eclipse Foundation[11][12]. AsciiDoc® та AsciiDoc Language™ — зареєстровані торгові марки Eclipse Foundation.
Приклад[ред. | ред. код]
Текст із використанням розмітки AsciiDoc та його візуалізація, аналогічна до тієї, яку створює процесор AsciiDoc:
| Вихідний текст AsciiDoc |
|---|
= Моя стаття
П. Петренко
https://wikipedia.org[Вікіпедія] — це
онлайн-енциклопедія, доступна українською
та *багатьма* іншими мовами.
== Програмне забезпечення
Ви можете встановити 'назва пакунка',
скориставшись командою `apt`:
----
apt install назва-пакунка
----
== Матеріали
Найтвердіші матеріали в природі:
* фулерит
* лонсдейліт
* алмаз
|
| HTML-візуалізація розмітки |
|---|
П. Петренко Вікіпедія - це онлайн-енциклопедія,доступна українською та багатьма іншими мовами. Ви можете встановити назва пакунка, скориставшись командою apt: apt install назва-пакунка Найтвердіші матеріали в природі:
|
Примітки[ред. | ред. код]
- ↑ What is the preferred file name extension for AsciiDoc files?
- ↑ Compare AsciiDoc to Markdown | Asciidoctor Docs. Архів оригіналу за 6 квітня 2023. Процитовано 9 квітня 2023.
- ↑ Markdown, Asciidoc, or reStructuredText — a tale of docs-as-code — Dewan’s Blog. Архів оригіналу за 9 квітня 2023. Процитовано 9 квітня 2023.
- ↑ AsciiDoc. Архів оригіналу за 3 березня 2016. Процитовано 18 жовтня 2013.
- ↑ AsciiDoc Frequently Asked Questions. asciidoc.org. Архів оригіналу за 13 березня 2022. Процитовано 20 березня 2020.
- ↑ AsciiDoc Recommended Practices | Asciidoctor. asciidoctor.org. Архів оригіналу за 21 червня 2022. Процитовано 20 березня 2020.
- ↑ AsciiDoc, powered by Asciidoctor, returns to GitHub and its 5+ million repositories. Архів оригіналу за 1 листопада 2017. Процитовано 7 квітня 2023.
- ↑ Asciidoc. GitLab User Docs. Архів оригіналу за 22 липня 2019. Процитовано 6 лютого 2020.
- ↑ Atlas Introduction. Author Welcome Kit. O'Reilly Media. Архів оригіналу за 14 жовтня 2017. Процитовано 19 травня 2016.
- ↑ Git wiki. Git SCM. Архів оригіналу за 16 серпня 2021. Процитовано 7 квітня 2023.
- ↑ AsciiDoc Working Group Charter. Архів оригіналу за 8 лютого 2023. Процитовано 7 квітня 2023.
- ↑ AsciiDoc Language. Архів оригіналу за 19 червня 2021. Процитовано 7 квітня 2023.
Посилання[ред. | ред. код]
- Офіційний сайт
- Using AsciiDoc and Asciidoctor to write documentation — посібник зі створення документації за допомогою AsciiDoc і Asciidoctor
- asciidoclive.com — безплатний онлайн-редактор AsciiDoc
| |||||||||||