AsciiDoc 语言文档
关于 AsciiDoc
AsciiDoc 是一种轻量级、语义化标记语言,主要用于编写技术文档。该语言可以从简洁、易读的纯文本格式编码的内容生成各种富含表现力的输出格式。
AsciiDoc 语法直观,因为它建立在成熟的纯文本约定之上,用于标记和组织文本。不熟悉 AsciiDoc 的人可能仅通过外观就能猜测出其许多语法元素的作用。这是因为语法元素的选择经过精心设计,使其看起来就像它们所代表的含义(这是科技行业长期以来采用的一种做法)。
AsciiDoc 处理器可以解析和理解 AsciiDoc 源文档,并将解析后的文档结构转换为一种或多种输出格式,例如 HTML、PDF、EPUB3、man(手册)页或 DocBook。AsciiDoc 语言与由此产生的输出没有绑定。生成多种输出格式的能力是 AsciiDoc 的主要优势之一。这种能力使其能够用于静态网站生成器、帮助文本、书籍出版、IDE、git 工具和服务、CI/CD 系统以及其他新颖的用途。
AsciiDoc 弥合了易于编写与技术撰写和出版的严格要求之间的差距。AsciiDoc 只需要文本编辑器即可阅读或编写,从而降低了入门门槛。
关于本说明文档
您正在阅读的是由 Asciidoctor 实现的 AsciiDoc 语言的用户面向文档。本说明文档不涵盖如何设置和使用 Asciidoctor 来处理 AsciiDoc 内容。您可以在本网站的 Asciidoctor 部分找到相关文档。
本说明文档已作为对 Eclipse AsciiDoc 语言项目 的初步贡献。该项目将以此文档为基础,起草 AsciiDoc 语言的规范。它还将作为 AsciiDoc 语言的用户面向指南的草稿,该指南也将由该项目维护。
在 AsciiDoc 语言规范的第一个版本获得批准之前,AsciiDoc 由 Asciidoctor 实现定义。该语言没有其他官方定义。
AsciiDoc 的说明文档将保留在此网站上,直到 AsciiDoc 语言项目开始发布其自己的 AsciiDoc 语言说明文档。
在此之前,让我们开始吧!