Stylemark 使用指南

2024-09-10 08:50:51作者：昌雅子Ethen

1. 项目目录结构及介绍

Stylemark 是一个用于生成交互式样式指南的工具，基于Node.js。尽管具体的仓库目录结构可能随时间和版本更新有所变化，一般的开源项目会有以下典型结构：

├── bin                     # 可执行脚本目录
├── src                     # 核心源代码目录
├── test                    # 测试文件目录
├── .gitignore              # 忽略提交到Git的文件列表
├── travis.yml              # Travis CI的配置文件
├── LICENSE                 # 许可证文件
├── README-SPEC.md          # 有关规范的说明文档
├── README.md               # 主要的项目说明文档
├── gulpfile.js             # Gulp构建任务文件
├── index.js                # 入口文件或者主要逻辑所在
├── package-lock.json       # NPM依赖锁定文件
├── package.json            # 包含项目元数据，包括依赖和脚本命令

bin: 存放执行脚本，使项目可直接通过命令行调用。
src: 源码存放位置，包含了Stylemark的核心逻辑。
test: 单元测试或集成测试文件。
.gitignore: 指定不纳入Git版本控制的文件类型或路径。
travis.yml: 自动化部署或测试配置，特别适用于GitHub Actions或其他CI/CD服务。
LICENSE: 项目使用的开放源代码许可证类型。
文档相关(README.md, README-SPEC.md): 项目介绍、使用方法等重要文档。
gulpfile.js: 如果存在，可能是用于自动化任务（如构建、测试）。
index.js: 主程序入口点。
package-lock.json 和 package.json: NPM包管理相关文件，记录了项目的依赖及其版本。

2. 项目的启动文件介绍

在Stylemark中，虽然直接的“启动文件”概念更多与命令行操作关联，但若要运行它，主要是通过NPM命令来实现。典型的启动过程并不涉及直接编辑某个特定的启动文件，而是通过npm scripts定义的命令，比如：

npm install -g stylemark
stylemark -i [源码路径] -o [输出HTML路径]

这里，全局安装Stylemark后，通过stylemark命令，配合必要的参数 -i 输入目录和 -o 输出目录来生成静态HTML样式指南。不存在一个显式的“启动文件”，命令行是主要的互动接口。

3. 项目的配置文件介绍

Stylemark支持通过YAML格式的配置文件来自定义其行为，该文件默认命名为stylemark.yml并应位于输入目录的根部，也可以通过命令行指定不同的路径。配置文件允许用户自定义多个方面，如：

name: "我的样式指南"
excludeDir: ["node_modules", ".git"]    # 要排除的目录
match: "*.js, *.jsx, *.css"            # 处理的文件模式
assets: ["assets/images"]               # 需要复制到生成的风格指南中的额外资源
theme:                                # 自定义主题设置
  logo: "logo.svg"                     # 风格指南的Logo