Mermaid CLI 安装与使用指南

Mermaid CLI 安装与使用指南

项目地址:https://gitcode.com/gh_mirrors/me/mermaid-cli

一、项目目录结构及介绍

在 mermaid-js/mermaid-cli 项目中，主要的目录结构如下：

.
├── README.md        # 主要的项目说明文档
├── src              # 包含 CLI 工具的主要源代码
│   ├── index.js      # 入口文件，处理命令行参数并调用相应功能
│   └── ...           # 其他相关源码文件
├── package.json     # 项目依赖及脚本定义
└── ...

src/index.js 是 CLI 的起点，它解析命令行输入，然后调用 Mermaid 库来生成图表。

二、项目的启动文件介绍

Mermaid CLI 是一个命令行工具，不包含传统的 "启动文件"。它的入口点是通过 npm 或 yarn 命令执行的，例如 npx @mermaid-js/mermaid-cli 或者全局安装后的 mmdc 命令。当运行这些命令时，package.json 中的 bin 字段定义的脚本会被调用，这将引导执行 src/index.js 文件中的逻辑。

{
  "name": "@mermaid-js/mermaid-cli",
  "bin": {
    "mmdc": "./bin/cli.js"
  },
  // ...
}

bin/cli.js 是一个简单的 JavaScript 脚本，用于桥接 CLI 命令到实际的执行文件 src/index.js。

三、项目的配置文件介绍

Mermaid CLI 配置文件通常不在其自身项目中，而是由用户在其自己的项目中创建。这个配置文件可以是一个 .mmdc.config.js 或 .mmdc.config.cjs 文件，用于定制图表的样式、主题等。例如：

module.exports = {
  themeConfig: {
    theme: 'neutral',
    font: 'system',
  },
  htmlClass: 'my-custom-class',
  diagramPadding: 5,
};

通过这个配置文件，你可以自定义 Mermaid CLI 在生成图表时使用的各种设置。当你运行 mmdc 命令时，可以使用 -c 或 --config 参数指定配置文件路径。

mmdc -i input.mmd -o output.svg --config myConfigFile.js

请注意，如果你未提供配置文件，Mermaid CLI 将使用默认设置生成图表。

了解更多详细信息和使用案例，可参考 Mermaid CLI 的官方文档。

mermaid-cli Command line tool for the Mermaid library 项目地址: https://gitcode.com/gh_mirrors/me/mermaid-cli