https://github.com/luoyunchong/igeekfan-docs
为开发者提供CMS、dotNET、FreeKit 相关文档
https://github.com/luoyunchong/igeekfan-docs
cms dotnetcore freekit freesql lin-cms-dotnetcore vue vuepress vuepress-next vuepress-theme-hope
Last synced: 3 months ago
JSON representation
为开发者提供CMS、dotNET、FreeKit 相关文档
- Host: GitHub
- URL: https://github.com/luoyunchong/igeekfan-docs
- Owner: luoyunchong
- Created: 2020-02-28T11:06:19.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-01T08:10:50.000Z (about 1 year ago)
- Last Synced: 2024-10-13T07:07:34.146Z (12 months ago)
- Topics: cms, dotnetcore, freekit, freesql, lin-cms-dotnetcore, vue, vuepress, vuepress-next, vuepress-theme-hope
- Language: Shell
- Homepage: https://igeekfan.cn
- Size: 17.9 MB
- Stars: 11
- Watchers: 3
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Freekit Docs
项目使用 vuepress，其可专注于文档构建
## install
```bash
npm install -g pnpm@next-7
```
```bash
pnpm install
```
## run
```bash
pnpm dev:vite
```
## build
```bash
pnpm build:vite
```
## upgrade package
```bash
pnpm i -D vuepress@next
```
## vuepress
该采用`vuepress-next`搭建，内置`md`，可以采用`vue`语法，vue 作者出品,UI 主题是 vuepress-theme-hope
- [https://vuepress-theme-hope.github.io/v2/](https://vuepress-theme-hope.github.io/v2/)
## 文档源码
- [https://github.com/luoyunchong/igeekfan-docs](https://github.com/luoyunchong/igeekfan-docs)
- [https://gitee.com/igeekfan/igeekfan-docs](https://gitee.com/igeekfan/igeekfan-docs)
## 部署地址
- [https://luoyunchong.github.io/igeekfan-docs/](https://luoyunchong.github.io/igeekfan-docs)
- [https://igeekfan.gitee.io/igeekfan-docs/](https://igeekfan.gitee.io/igeekfan-docs)
- [https://igeekfan.cn](https://igeekfan.cn)
## package.json 介绍
package.json 有这些命令
```bash
"scripts": {
"build:vite": "vuepress-vite build docs",
"dev:vite": "vuepress-vite dev docs",
},
```
所以我们可以 pnpm dev:vite 或 pnpm build:vite
## 自动发布 至 github pages
### 在 git bash 中执行
```bash
pnpm deploy
```
或
### powershell 中执行如下内容
```bash
.\deploy.ps1
```
## nginx 配置
nginx 相关配置，/etc/nginx/conf.d/新建一个以.conf 为后缀的文件即可。
```bash
cd /etc/nginx/conf.d/
touch igeekfan-docs.conf
```
```conf
server {
listen 80;
server_name www.igeekfan.cn;
root /var/www/html/igeekfan-docs;
charset utf-8;
location / {
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $http_host;
}
}
```
```bash
# 判断配置是否有效
nginx -t
# 加载配置项
nginx -s reload
```