Doxia 标记语言参考
下表概述了 Doxia 目前支持的标记语言:
- 如果Parser可用于给定格式,则意味着您可以用这种语言编写文档,Doxia 可以从中生成输出,
- 如果Sink可用,则意味着您可以生成此格式的输出。
源目录是 Maven 需要这种格式的源文档的目录(例如src/site/apt/
Apt),文件扩展名是默认的文件扩展名,解析器 id 给出了 plexus 用来查找相应组件的唯一标识符。
格式 | 简短的介绍 | 解析器 (输入) |
接收器 (输出) |
源目录 | 文件扩展名 | Doxia 模块 | 解析器 ID |
---|---|---|---|---|---|---|---|
易于 | 几乎纯文本 | apt |
apt |
doxia-module-apt |
apt |
||
ASCII文档 | Asciidoctor Maven 插件 | asciidoc |
adoc ,asciidoc |
asciidoctor-maven-plugin |
asciidoc |
||
合流 | Confluence 企业维基 | * | confluence |
confluence |
doxia-module-confluence |
confluence |
|
简化文档 | 简化的 DocBook XML 标准 | docbook |
xml |
doxia-module-docbook-simple |
docbook |
||
FML | 常见问题标记语言 | fml |
fml |
doxia-module-fml |
fml |
||
降价** | Markdown 标记语言 | markdown |
md , markdown *** |
doxia-module-markdown |
markdown |
||
维基* | TWiki 结构化 Wiki | twiki |
twiki |
doxia-module-twiki |
twiki |
||
Xdoc | XML 文档格式 | xdoc |
xml |
doxia-module-xdoc |
xdoc |
||
XHTML | 可扩展超文本标记语言 | xhtml |
xhtml |
doxia-module-xhtml |
xhtml |
请注意,站点插件默认不包含某些模块。在这里查看可用的模块:https ://repo.maven.apache.org/maven2/org/apache/maven/doxia/ 。
如果您需要为 maven 站点插件添加模块,只需将其添加为插件的依赖项
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-site-plugin</artifactId> <version>3.2</version> <dependencies> <dependency> <groupId>org.apache.maven.doxia</groupId> <artifactId>doxia-module-markdown</artifactId> <version>1.3</version> </dependency> </dependencies> </plugin>
*从 Doxia 1.1 开始
**从 Doxia 1.3 开始
***从 Doxia 1.7 开始
Doxia 页面输出格式(已弃用)
下表概述了仅输出的面向页面的已弃用(在 Doxia 1.11 中)格式:
格式 | 简短的介绍 | Doxia 模块 |
---|---|---|
文字 | iText PDF 库 | doxia-module-itext |
佛* | XSL 格式化对象 (XSL-FO) | doxia-module-fo |
乳胶 | LaTeX排版系统 | doxia-module-latex |
RTF | 微软富文本格式 | doxia-module-rtf |