简介

使用 VuePress 配合 Hope Theme 搭建的使用文档

查看

文档托管于 GitHub Pages，点击 这里 查看

开发

请使用 Visual Studio Code 开发，并安装 推荐扩展 以获得更好的开发体验

克隆项目

git clone -b docs https://github.com/whitechi73/OpenShamrock # 注意指定docs分支

安装依赖

请使用 pnpm 安装依赖

pnpm install

启动开发服务器

pnpm dev

构建

pnpm build

开源协议

本项目使用 GPL-3.0 协议开放源代码

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/>.

贡献者