将参数传递给asciidoc中的模板文件

时间:2016-05-18 23:20:31

标签: asciidoc

我使用Spring rest docs生成asciidoc片段。

我可以在我的文档页面中包含生成的代码段。但是,我想在一个单独的adoc文件中定义每个secion的结构,并为我的索引文件中的每个文件都有一行。

目前我的 index.adoc 文件如下所示:

= My Http Api Docs

= GET /units/:id

== Path Parameters
include::{snippets}/units/get/path-parameters.adoc[]

== Response Fields
include::{snippets}/units/get/response-fields.adoc[]

我希望它是这样的

index.adoc

= My Http Api Docs

usemytemplates::mytemplate.adoc[method='get', url='units', desc='/units/:id']

mytemplate.adoc

= {method} {desc}

== Path Parameters
include::{snippets}/{url}/{method}/path-parameters.adoc[]

== Response Fields
include::{snippets}/{url}/{method}/response-fields.adoc[]

任何人都知道如何做到这样的事情?

1 个答案:

答案 0 :(得分:5)

我能够通过在每个include语句之前使用替换语法来解决这个问题。

我的index.adoc文件看起来像这样,它可以工作:

:method: get
:url: units
:desc: /utils/:id
include::mytemplate.adoc[]

:method: get
:url: members
:desc: /members/:id
include::mytemplate.adoc[]