时间戳

首页 > 解决方案 > 如何在 gitlab 中将 asciidoc 与源代码连接起来？

gitlab - 如何在 gitlab 中将 asciidoc 与源代码连接起来？

问题描述

我用 Gitlab 管理我的 Spring Boot 项目。(git@gitlab.com:user/project.git)。

我将文档保存在 Gitlab 提供的单独 wiki 项目中。（所以 git@gitlab.com:user/project.wiki.git）。

现在我想直接从文档中引用项目中的源代码并列出代码片段进行解释。这样，代码将始终是最新的，您只需在必要时调整解释。但是如何从 wiki 项目链接到远程文件？举个例子，这就是它以后的样子。

[source,java]
----
include:: https://gitlab.com/user/project/-/raw/master/src/main/java/de/mycompany/project/ProjectApp.java[]
----

标签： gitlabdocumentationasciidoc

解决方案

asciidoctor不提供执行远程包含的方法：所有包含内容都必须在本地文件系统中。

如果你使用asciidoctor.js，你可以使用这个扩展：https ://github.com/feelpp/asciidoctor-remote-include-processor

否则，您可以使用某种形式的构建协调，例如 make、Ant 等，将远程内容获取到已知的本地位置，更新您的 Asciidoc 文档以包含现在的本地位置，然后运行asciidoctor​​.

推荐阅读