在 IntelliJ Idea 中启用渲染 asciidoc 操作

Enable rendering asciidoc operation in InteliJ Idea

在 InteliJ Idea 中使用 spring-restdocs 记录 rest api 很好,但我缺少 operation 宏的渲染 "include" 片段。

== Get Comments sorted

To get sorted according single attribute and with no specific ordering (asc-ending is default), you can refer to this example:

operation::comments/getSortedDescending[snippets='http-request,path-parameters,http-response']

我希望我能以某种方式启用 spring-restdocs-asciidoc 人工制品,以便在使用 asciidoctor 插件在 InteliJ Idea 中渲染内容时使用。

相关问题https://github.com/asciidoctor/asciidoctor-intellij-plugin/issues/310

我看过 spring-restdocs-asciidoctor。 The operation::[] is an extension 呈现内容。它依赖于需要设置的属性 snippets

AsciiDoc 的 IntelliJ 插件支持 ruby extensions and attributes for previews 作为实验选项。

为了让它发挥作用,我做了以下工作:

  • 签出项目
  • 运行宁 gradlew asciidoctor 生成片段
  • 添加一个文件.asciidoctorconfig来设置生成的片段的路径
  • 添加一个目录.asciidoctor并将扩展程序放在这个目录中
  • 确认IDE
  • 中的警告信息"This project contains Asciidoctor Extensions..."

每次重新启动 IDE 时都需要确认警告消息。因为它会 运行 Ruby 在本地编码,所以这是一个安全问题。也许我们以后会加强它,所以你只需要在扩展代码更改后重新确认它。

更改在以下分支上:https://github.com/ahus1/spring-restdocs/tree/poc_extension_intellij