mdPage 项目使用文档

mdPage 项目使用文档

md-page📝 create a webpage with just markdown项目地址:https://gitcode.com/gh_mirrors/md/md-page

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

mdPage 是一个用于从 Markdown 文件生成单页 HTML 文档的工具。以下是项目的目录结构及其介绍：

mdPage/
├── assets/          # 静态资源文件
├── docs/            # 文档源文件和生成的文档
├── src/             # Rust 源代码
├── tests/           # 测试文件
├── .gitignore       # Git 忽略文件配置
├── Cargo.toml       # Rust 项目配置文件
├── LICENSE          # 项目许可证
├── README.md        # 项目说明文档

目录结构详细介绍

• assets/: 包含项目所需的静态资源文件，如图片、图标等。
• docs/: 包含 Markdown 源文件和生成的 HTML 文档。
• src/: 包含 Rust 语言编写的源代码。
• tests/: 包含项目的测试文件。
• .gitignore: 配置 Git 版本控制系统忽略的文件和目录。
• Cargo.toml: Rust 项目的配置文件，包含项目依赖、版本等信息。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档，包含项目的基本信息和使用方法。

2. 项目的启动文件介绍

mdPage 项目的启动文件是 src/main.rs。这个文件包含了程序的入口点，负责初始化和调用其他模块来生成 HTML 文档。

// src/main.rs
fn main() {
    // 初始化配置
    let config = load_config();
    // 生成文档
    generate_docs(config);
}

启动文件详细介绍

• main.rs: 主程序文件，负责加载配置和调用生成文档的函数。

3. 项目的配置文件介绍

mdPage 项目的配置文件是 mdpage.json。这个文件用于指定生成文档时的各种配置选项，如标题、子标题、内容顺序等。

{
  "subtitle": "Dir config example",
  "contents": [
    { "dir": " /sections" },
    { "file": " /config/page1.md" },
    { "dir": " /basic" },
    { "file": " /single_index/readme.md" },
    { "dir": " /single_page" }
  ]
}

配置文件详细介绍

• mdpage.json: 配置文件，包含生成文档时的各种选项。
  • subtitle: 文档的子标题。
  • contents: 文档内容的配置，可以指定目录或文件。

通过以上介绍，您可以更好地理解和使用 mdPage 项目。希望这份文档对您有所帮助。

md-page📝 create a webpage with just markdown项目地址:https://gitcode.com/gh_mirrors/md/md-page