Allmark 项目启动与配置教程

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

Allmark 是一个功能强大的 Markdown 文档查看器，它提供了丰富的功能来帮助用户更好地阅读和展示 Markdown 文档。以下是 Allmark 项目的主要目录结构及其介绍：

• cmd：存放 Allmark 命令行工具的代码。
• docs：包含项目的文档，包括安装指南、用户手册和 API 文档。
• internal：包含 Allmark 内部使用的模块和包。
• pkg：包含 Allmark 的主要功能模块，如解析器、渲染器等。
• web：包含 Allmark 的 Web 界面相关代码。
• test：存放项目的测试代码。
• Makefile：构建和测试项目的 Makefile 文件。
• go.mod：Go 语言的依赖管理文件。
• go.sum：记录项目依赖的校验和文件。

2. 项目的启动文件介绍

Allmark 的启动主要通过命令行工具进行。启动文件位于 cmd/allmark 目录下，主要包含以下文件：

• main.go：这是 Allmark 命令行工具的入口文件。它解析命令行参数，并根据用户输入执行相应的操作。

启动 Allmark 的基本命令如下：

go run cmd/allmark/main.go [选项] [Markdown 文件路径]

或者，如果你已经将 Allmark 编译成了可执行文件，可以直接运行：

./allmark [选项] [Markdown 文件路径]

选项可能包括：

• -h, --help：显示帮助信息。
• -v, --version：显示 Allmark 的版本。

3. 项目的配置文件介绍

Allmark 使用配置文件来定义一些运行时的设置。默认情况下，配置文件名为 allmark.json，位于项目的根目录。

以下是 allmark.json 的一个基本示例：

{
  "server": {
    "port": 8080,
    "address": "localhost"
  },
  "theme": "default",
  "markdown": {
    "extensions": ["tables", "fenced_code_blocks"]
  }
}

在这个配置文件中：

• server：定义了 Allmark Web 服务的端口和地址。
• theme：指定了使用的主题样式。
• markdown：定义了要启用哪些 Markdown 扩展。

用户可以根据自己的需求修改配置文件，以调整 Allmark 的行为。