提交 67b095bf 编写于 作者: EvanOne(文一)'s avatar EvanOne(文一)

chore: Modify the config for docs

上级 70e83100
......@@ -39,7 +39,33 @@ module.exports = {
}
},
sidebar: {
'/': getEnSidebar('Guide'),
'/': [
{
title: 'Guide',
collapsable: false,
children: [
'/guide/quick-start',
'/guide/primary',
],
},
{
title: 'Advanced',
collapsable: false,
children: [
'/advanced/advanced',
'/advanced/third-part',
'/advanced/assist',
'/advanced/optimize',
],
},
{
title: 'Contribution',
collapsable: false,
children: [
'/contribute/contribute',
],
},
],
},
nav: [
{
......@@ -94,7 +120,33 @@ module.exports = {
}
},
sidebar: {
'/zh-CN/': getZhSidebar('配置指南'),
'/zh-CN/': [
{
title: '配置指南',
collapsable: false,
children: [
'/zh-CN/guide/quick-start',
'/zh-CN/guide/primary',
],
},
{
title: '高级设置',
collapsable: false,
children: [
'/zh-CN/advanced/advanced',
'/zh-CN/advanced/third-part',
'/zh-CN/advanced/assist',
'/zh-CN/advanced/optimize',
],
},
{
title: '参与贡献',
collapsable: false,
children: [
'/zh-CN/contribute/contribute',
],
},
],
},
nav: [
{
......@@ -133,46 +185,10 @@ module.exports = {
},
{
text: '参与贡献',
link: '/zh-CN/contribute/',
link: '/zh-CN/contribute/contribute',
},
],
},
},
},
};
function getEnSidebar(title) {
return [
{
title,
collapsable: false,
children: [
'/guide/quick-start',
'/guide/primary',
'/advanced/advanced',
'/advanced/third-part',
'/advanced/assist',
'/advanced/optimize',
'/contribute/',
],
},
];
}
function getZhSidebar(title) {
return [
{
title,
collapsable: false,
children: [
'/zh-CN/guide/quick-start',
'/zh-CN/guide/primary',
'/zh-CN/advanced/advanced',
'/zh-CN/advanced/third-part',
'/zh-CN/advanced/assist',
'/zh-CN/advanced/optimize',
'/zh-CN/contribute/',
],
},
];
}
## <div align="center" style="color: #73c8ff;font-size: 36px;"><a title="Go to homepage" href="https://github.com/liuyib/hexo-theme-stun"><img align="center" width="60" height="60" src="https://raw.githubusercontent.com/liuyib/hexo-theme-stun/master/source/images/icons/stun-logo.svg?sanitize=true"></a> t u n</div>
# Contribution <!-- omit in toc -->
<div align="center" style="color: #73c8ff;font-size: 36px;"><a title="Go to homepage" href="https://github.com/liuyib/hexo-theme-stun"><img align="center" width="60" height="60" src="https://raw.githubusercontent.com/liuyib/hexo-theme-stun/master/source/images/icons/stun-logo.svg?sanitize=true"></a> t u n</div>
Hi! I'm really excited that you are interested in contributing to «Stun». Before submitting your contribution, please make sure to take a moment and read through the following guidelines:
......@@ -6,7 +8,7 @@ Hi! I'm really excited that you are interested in contributing to «Stun». Befo
- [Development Setup](#development-setup)
- [Commit Messages Rules](#commit-messages-rules)
### Pull Request Guidelines
## Pull Request Guidelines
The `master` branch is just a snapshot of the latest stable release. All development should be done in dedicated branches. **Do not submit PRs against the `master` branch**.
......@@ -16,7 +18,7 @@ The `master` branch is just a snapshot of the latest stable release. All develop
- Push the commit to the repository of fork.
- Create a Pull request to the **dev branch** of the Stun theme repository.
### Development Setup
## Development Setup
You need to install [Node.js](http://nodejs.org/) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).
......@@ -26,7 +28,7 @@ After cloning the repo, run:
$ npm install
```
### Commit Messages Rules
## Commit Messages Rules
We agree on the format of Git commit information, and each commit information is composed of `type` + `subject`, which will improve the readability of the project log.
......@@ -39,11 +41,12 @@ We agree on the format of Git commit information, and each commit information is
- `test`: Code test correlation
- `chore`: Changes to basic build tools or dependent libraries (no source code involved)
- `revert`: Revert some existing commits
- `subject` contains a succinct description of the change, like `Update quick start in readme.md`
- `subject` contains a succinct description of the change, like `Update quick start in readme.md`
- No dot (`.`) at the end
- Use the imperative, present tense ("change" not "changed" nor "changes")
### Contributors
<!-- omit in toc -->
## Contributors
Thank you to all the people who have already contributed to «Stun»!
......
## <div align="center" style="color: #73c8ff;font-size: 36px;"><a title="Go to homepage" href="https://github.com/liuyib/hexo-theme-stun"><img align="center" width="60" height="60" src="https://raw.githubusercontent.com/liuyib/hexo-theme-stun/master/source/images/icons/stun-logo.svg?sanitize=true"></a> t u n</div>
# 贡献准则 <!-- omit in toc -->
<div align="center" style="color: #73c8ff;font-size: 36px;"><a title="Go to homepage" href="https://github.com/liuyib/hexo-theme-stun"><img align="center" width="60" height="60" src="https://raw.githubusercontent.com/liuyib/hexo-theme-stun/master/source/images/icons/stun-logo.svg?sanitize=true"></a> t u n</div>
嗨!我很高兴您有兴趣为 «Stun» 做贡献。在进行贡献之前,请务必花一些时间通读以下准则:
......@@ -6,7 +8,7 @@
- [开发之前的准备](#%e5%bc%80%e5%8f%91%e4%b9%8b%e5%89%8d%e7%9a%84%e5%87%86%e5%a4%87)
- [提交信息规范](#%e6%8f%90%e4%ba%a4%e4%bf%a1%e6%81%af%e8%a7%84%e8%8c%83)
### Pull request 准则
## Pull request 准则
要知道,`master` 分支只是最新稳定版本的一个快照。所有的开发都应该在专门的分支中进行,**不要向 `master` 分支提交 PRs**
......@@ -16,7 +18,7 @@
- 将提交 push 到 fork 的仓库下
- 创建一个 Pull request 到 Stun 主题仓库的 **dev 分支**
### 开发之前的准备
## 开发之前的准备
你需要安装 [Node.js](http://nodejs.org/)[npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
......@@ -26,11 +28,11 @@
$ npm install
```
### 提交信息规范
## 提交信息规范
我们对项目的 git 提交信息格式进行统一格式约定,每条提交信息由 `type` + `subject` 组成,这将提升项目日志的可读性。
- `type` 用于述此次提交信息的意义,全小写,仅包括如下类型:
- `type` 用于述此次提交信息的意义,全小写,仅包括如下类型:
- `feat`:新功能
- `fix`:Bug 修复
- `refactor`:重构(既不是新增功能,也不是修改 Bug 的代码变动)
......@@ -43,7 +45,8 @@ $ npm install
- 句尾不要使用符号
- 使用现在时、祈使句语气
### 贡献者
<!-- omit in toc -->
## 贡献人员
感谢所有为 «Stun» 做出贡献的人!
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册