Skip to content

zotero-chinese/styles.dev

Repository files navigation

Styles

状态

这个仓库临时性作为 styles 预览的开发,尚未完成,获取文件请前往上述几个仓库。

Note

本仓库仅作为 styles 仓库重构的原型,不接受样式反馈和样式文件请求。 在开发完成前,请前往 redleafnew/Chinese-STD-GB-T-7714-related-csl 反馈关于 CSL 文件的问题。

访问

https://zotero-chinese.com/styles

进展

待办事项

技术路线

CSL 文件存放在 src/ 下。每次提交时,触发 Actions 运行 lib/main.ts,执行:

  • 生成引文和书目预览( citeproc-js 实现)
    • 默认使用 lib/data/items/*.json 作为默认条目数据,可以在样式同级目录建立 items.json 来增加。
    • 默认使用 lib/data/citations/default-sample-cites-*.json 作为示例引用指针源,可以在样式文件同级目录下建立 cites.json 来覆盖默认值。
    • 始终使用 lib/data/citations/default-test-cites-*.json 作为测试引用指针源。
  • 提取 cs:info 数据,
  • 将元数据写入样式文件同级目录的 metadata.json
  • 将预览结果写入样式文件同级目录的 index.md

运行

项目运行需要安装 Node.js

# Clone 这个仓库
git clone https://github.com/zotero-chinese/styles.git --recursive

# 进入项目目录
cd styles

# 如果是第一次接触 Node.js 或运行后续命令时提示 yarn 命令不存在,
# 请执行下一行以安装 pnpm 包管理器
npm install -g pnpm

# 安装依赖
pnpm install

# 监听 CSL 文件变化并热更新
pnpm dev

# 生成所有数据
pnpm build

# 预览一个 CSL 的结果
pnpm preview "csl path related to project root"
# 你也可以直接运行脚本
tsx ./lib/index.ts "csl path related to project root"

贡献指南

运行与构建请参上文。