微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

如何将 asciidoc 与 gitlab 中的源代码连接起来?

如何解决如何将 asciidoc 与 gitlab 中的源代码连接起来?

我使用 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[]
----

解决方法

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

如果您使用 asciidoctor.js,则可以使用此扩展名:https://github.com/feelpp/asciidoctor-remote-include-processor

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。