mirror of
https://github.com/whitechi73/OpenShamrock.git
synced 2024-08-14 13:12:17 +08:00
78 lines
2.0 KiB
Markdown
78 lines
2.0 KiB
Markdown
<div align="center">
|
|
|
|
![][banner]
|
|
|
|
</div>
|
|
|
|
## 简介
|
|
|
|
使用 [VuePress][vuepress] 配合 [Hope Theme][hope-theme] 搭建的使用文档
|
|
|
|
## 查看
|
|
|
|
文档托管于 [GitHub Pages][github-pages]，点击 [这里][shamrock-docs] 查看
|
|
|
|
## 开发
|
|
|
|
请使用 [Visual Studio Code][vscode] 开发，并安装 [推荐扩展][recommend-extensions] 以获得更好的开发体验
|
|
|
|
### 克隆项目
|
|
|
|
```bash
|
|
git clone -b docs https://github.com/whitechi73/OpenShamrock # 注意指定docs分支
|
|
```
|
|
|
|
### 安装依赖
|
|
|
|
请使用 [pnpm][pnpm] 安装依赖
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
### 启动开发服务器
|
|
|
|
```bash
|
|
pnpm dev
|
|
```
|
|
|
|
### 构建
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
## 开源协议
|
|
|
|
本项目使用 [GPL-3.0](LICENSE) 协议开放源代码
|
|
|
|
```text
|
|
Shamrock Docs
|
|
Copyright (C) 2023 ZhenXin
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
```
|
|
|
|
## 贡献者
|
|
|
|
[![][contrib-image]][contrib-link]
|
|
|
|
[banner]: https://socialify.git.ci/whitechi73/OpenShamrock/image?description=1&forks=1&issues=1&language=1&name=1&owner=1&pulls=1&stargazers=1&theme=Auto
|
|
[vuepress]: https://vuepress.vuejs.org/zh/
|
|
[hope-theme]: https://vuepress-theme-hope.github.io/zh/
|
|
[github-pages]: https://pages.github.com/
|
|
[shamrock-docs]: https://whitechi73.github.io/OpenShamrock/
|
|
[vscode]: https://code.visualstudio.com/
|
|
[recommend-extensions]: .vscode/extensions.json
|
|
[pnpm]: https://pnpm.io/
|
|
[contrib-image]: https://contrib.rocks/image?repo=whitechi73/OpenShamrock
|
|
[contrib-link]: https://github.com/whitechi73/OpenShamrock/graphs/contributors
|