标记简单的 PlantUML 插件

remark-simple-plantuml 是一个简单的插件 评论j 将 PlantUML 代码块转换成图像节点.

安装

npm install --save @akebifiky/remark-simple-plantuml

示例

您可以使用此插件, 如以下

标记

# Your markdown including PlantUML code block

```plantuml Your title
class SimplePlantUMLPlugin {
    + transform(syntaxTree: AST): AST
}
```

Java 脚本

const remark = require("remark");
const simplePlantUML = require("@akebifiky/remark-simple-plantuml");
const fs = require("fs");
const path = require("path");

const input = fs.readFileSync(path.resolve(__dirname, "./your-markdown.md")).toString();
const output = remark().use(simplePlantUML).processSync(input).toString();

console.log(output);
// will be 
// > # Your markdown including PlantUML code block
// >
// > ![Your title](https://www.plantuml.com/plantuml/png/Iyv9B2vM2CxCBSX93SX9p2i9zVK9o2bDpynJgEPI009jXPAYnBpYjFoYN8tYohoIn8gGejHKAmN7u11DCCbL2m00)

插件选项

您可以通过“ baseUrl” 选项使用特定的 PlantUML 服务器 . (默认为 https://www.plantuml.com/plantuml/png(中文(简体) )

如果您想要使用 SVG , 您可以像以下配置 .

remark().use(simplePlantUML, { baseUrl: "https://www.plantuml.com/plantuml/svg" }).processSync(input);

一体化

您可以在任何框架中使用此插件支持注释js .

如果你想在经典预设中使用 Docusaurus 2 定义和我一样,在您的配置 docusaurus.config.js 喜欢跟随.

const simplePlantUML = require("@akebifiky/remark-simple-plantuml");

// your configurations...

presets: [
    [
      "@docusaurus/preset-classic",
      {
        docs: {
          sidebarPath: require.resolve("./sidebars.js"),
          remarkPlugins: [simplePlantUML]
        }
      }
    ]
  ],

//...