Skip to content

Commit

Permalink
将 about/ 内容移出子目录
Browse files Browse the repository at this point in the history
新增贡献者列表;对未完成文档添加待办标记;完善 csl 侧边栏配置
  • Loading branch information
northword committed Sep 22, 2023
1 parent 2a3d126 commit 1b960e2
Show file tree
Hide file tree
Showing 17 changed files with 88 additions and 26 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@

## 贡献指南

<https://zotero-chinese.com/about/contributing/CONTRIBUTING.html>
<https://zotero-chinese.com/contributing/>

## 致谢

Expand Down
2 changes: 1 addition & 1 deletion src/.vuepress/navbar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ export const zhNavbar = navbar([
{
text: "贡献指南",
icon: "creative",
link: "/about/contributing/CONTRIBUTING.md",
link: "/contributing/",
},
{
text: "关于 Zotero 中文小组",
Expand Down
15 changes: 15 additions & 0 deletions src/.vuepress/sidebar/csl-dev-guide.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
import { arraySidebar } from "vuepress-theme-hope";

export const cslDevGuide = arraySidebar([
// "",
"primer",
"xml-basic",
"specification",
{
text: "附录",
prefix: "appendix/",
collapsible: true,
children: "structure",
},
"translating-locale-files",
]);
23 changes: 20 additions & 3 deletions src/.vuepress/sidebar/index.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
import { userGuide } from "./user-guide";
import { cslDevGuide } from "./csl-dev-guide";
import { pluginDevGuide } from "./plugin-dev-guide";
import { sidebar } from "vuepress-theme-hope";

export const zhSidebar = sidebar({
"/user-guide/": userGuide,
"/plugin-dev-guide/": "structure",
"/csl-dev-guide/": "structure",
"/about/": "structure",
"/": "structure",
"/csl-dev-guide/": cslDevGuide,
"/": [
"about",
"contributors",
{
text: "贡献者指南",
icon: "build",
prefix: "contributing",
collapsible: true,
children: [
"contributing",
"markdown",
"markdown-demo",
"vscode-dev",
"build",
],
},
],
});
3 changes: 3 additions & 0 deletions src/.vuepress/sidebar/plugin-dev-guide.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import { arraySidebar } from "vuepress-theme-hope";

export const pluginDevGuide = arraySidebar([""]);
6 changes: 5 additions & 1 deletion src/.vuepress/theme.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ export default hopeTheme({
sidebar: zhSidebar,

footer:
"Zotero 中文小组 | <a href='/about/contributing/CONTRIBUTING.html'>贡献指南</a> | <a href='/'>参与讨论</a> | <a href='/'>加入 QQ 群组</a>",
"Zotero 中文小组 | <a href='/contributing/'>贡献指南</a> | <a href='/'>参与讨论</a> | <a href='/'>加入 QQ 群组</a>",

displayFooter: true,

Expand Down Expand Up @@ -90,6 +90,10 @@ export default hopeTheme({
// vuePlayground: true,
},

// autoCatalog: {
// orderGetter: (page) => {return page.routeMeta}
// },

// uncomment these if you want a pwa
// pwa: {
// favicon: "/favicon.ico",
Expand Down
2 changes: 1 addition & 1 deletion src/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ highlights:
- title: 贡献者指南
icon: like
details: 查看如何为项目做出贡献。
link: /about/contributing/CONTRIBUTING.html
link: /contributing/

- title: QQ 群
icon: group
Expand Down
12 changes: 12 additions & 0 deletions src/about.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 关于 Zotero 中文小组
icon: like
---

# 关于 Zotero 中文小组

::: tip

待办,关于页面

:::
5 changes: 0 additions & 5 deletions src/about/README.md

This file was deleted.

7 changes: 0 additions & 7 deletions src/about/contributing/README.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ npm install

3. 在新建分支中对文档做修改,修改过程中,可以随时在浏览器中检查修改效果

使用 Markdown 语法编写文档,如果你不清楚本文档所用的 Markdown 语法,请参阅 [Markdown 语法](./markdown.md)
使用 Markdown 语法编写文档,如果你不清楚本文档所用的 Markdown 语法,请参阅 [Markdown 语法](markdown.md)

4. 提交 commit

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以

若只是对文档做简单的微调,比如修改简单的别字、语句不通或不清晰的描述等,可以直接通过 GitHub 在线修改并提交,参阅后文 [简单修改](#简单修改)

若需要对文档做大量修改,可在经过讨论后,选择 [线下修改](./build.md)
若需要对文档做大量修改,可在经过讨论后,选择 [线下修改](build.md)

:::note

若不熟悉 Markdown 标记语言,可以参考 [Markdown 语法指南](./markdown.md)
若不熟悉 Markdown 标记语言,可以参考 [Markdown 语法指南](markdown.md)

:::

Expand All @@ -61,7 +61,7 @@ Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以

如果提示需要 fork 才能继续则点击即可。

编辑需要修改的地方,Markdown 语法请参阅 [Markdown 语法](./markdown-demo.md)
编辑需要修改的地方,Markdown 语法请参阅 [Markdown 语法](markdown-demo.md)

2. 提交修改

Expand All @@ -79,7 +79,7 @@ Zotero 中文文档接受多种形式的贡献,请阅读这一份指南,以

### 稍微大量修改

请参考 [使用 vscode.dev 指南](./vscode-dev.md)
请参考 [使用 vscode.dev 指南](vscode-dev.md)

### 大量修改

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ updated: 2023-07-21 18:15:30

[相对路径访问主页](../../README.md)

[相对路径访问贡献指南](./CONTRIBUTING.md)
[相对路径访问贡献指南](README.md)

```md
[相对路径访问主页](../../README.md)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@ title: 页面的标题

## Markdown 内容语法

查看 [Markdown 语法预览](./markdown-demo.md)
查看 [Markdown 语法预览](markdown-demo.md)
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
icon: build
---

# 通过 VSCode.dev 网站在线更改本文档

1. 打开 <https://vscode.dev/github/zotero-chinese/wiki>
Expand Down
13 changes: 13 additions & 0 deletions src/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
icon: group
---

# 贡献者名单

::: tip

待办,通过 `all-contributors``contrib.rocks` 显示所有贡献者。

需要将原语雀贡献者同步过来。

:::
6 changes: 6 additions & 0 deletions src/plugin-dev-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ updated: 2023-07-20 16:51:54
---

# 插件开发指南

::: tip

待完善,前托管于语雀的开发者文档主要针对 Zotero 6,鉴于插件在 Zotero 7 相对 Zotero 6 变动较大,因此插件开发者文档需要重写。

:::

0 comments on commit 1b960e2

Please sign in to comment.