Jekyll-Mermaid 项目教程

Jekyll-Mermaid 项目教程

jekyll-mermaidA Jekyll plugin to simplify the creation of mermaid diagrams and flowcharts in your posts and pages.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-mermaid

1. 项目的目录结构及介绍

Jekyll-Mermaid 项目的目录结构如下：

jekyll-mermaid/
├── lib/
│   └── jekyll-mermaid.rb
├── .gitignore
├── contributing.md
├── jekyll-mermaid.gemspec
├── LICENSE
├── README.md

• lib/: 包含项目的主要逻辑文件 jekyll-mermaid.rb。
• .gitignore: 指定 Git 版本控制系统忽略的文件和目录。
• contributing.md: 贡献指南，说明如何为项目做出贡献。
• jekyll-mermaid.gemspec: 项目的 gem 规范文件，包含 gem 的元数据和依赖项。
• LICENSE: 项目的许可证文件，本项目使用 MIT 许可证。
• README.md: 项目说明文件，包含项目的基本信息和使用指南。

2. 项目的启动文件介绍

项目的启动文件是 lib/jekyll-mermaid.rb。这个文件包含了 Jekyll 插件的主要逻辑，用于在 Jekyll 站点中渲染 Mermaid 图表。

3. 项目的配置文件介绍

项目的配置文件是 _config.yml。你需要在其中添加以下内容来启用 Jekyll-Mermaid 插件：

gems:
  - jekyll-mermaid

此外，你还可以在 _config.yml 中配置 Mermaid 的源 JavaScript 文件路径：

mermaid:
  src: 'path/to/mermaid.js'

这样，Jekyll 站点就可以使用 Mermaid 插件来生成图表了。

jekyll-mermaidA Jekyll plugin to simplify the creation of mermaid diagrams and flowcharts in your posts and pages.项目地址:https://gitcode.com/gh_mirrors/je/jekyll-mermaid