Skip to content

Commit

Permalink
fix&update: fix mkdocs, update README (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
Coconut-Aero authored Feb 10, 2025
1 parent 09575ef commit 009fe4a
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
43 changes: 42 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@
- **[通讯安全](./03-tools/Android/加密通讯.md)**
- **[密码管理](./03-tools/cyber%20security/password_manage1.md)**
- **[账号安全](./03-tools/cyber%20security/Authenticator.md)**
- **隐私保护**
- **[隐私保护](./03-tools/cyber%20security/privacy.md)**

#### 校园应用

Expand Down Expand Up @@ -131,3 +131,44 @@ QQ 群:搜索 860675581 或 点击链接加入群聊:[https://qm.qq.com/q/WJ
感谢所有参与到开发/测试中的朋友们,是大家的帮助让 AcWiKi 越来越好! (\*´▽`) ノノ

[![贡献者](https://contributors-img.web.app/image?repo=Ac-Wiki/AcWiKi&max=105&columns=15)](https://github.com/Ac-Wiki/AcWiKi/graphs/contributors)

# 5. 🖥️本地部署

## 5.1 克隆仓库

确保您安装了git,可于[Git](https://git-scm.com/)下载

在终端执行以下命令克隆仓库:
```shell
git clone https://github.com/Ac-Wiki/AcWiKi.git
```
## 5.2 初始化虚拟环境

进入仓库根目录,使用以下命令创建虚拟环境
```shell
python3 -m venv venv
```

- 对于 Linux / macOS 用户: 在终端中执行以下命令进入虚拟环境:
```shell
source venv/bin/activate
```

- 对于 Windows 用户:在PowerShell中执行以下命令进入虚拟环境:
```pwsh
venv\Scripts\activate.bat
```
## 5.3 安装依赖

仓库根目录下有`requirements.txt`,在虚拟环境中执行以下命令安装依赖:
```shell
pip install -r requirements.txt
```

## 5.4 构建本地网页

执行以下命令:
```shell
mkdocs serve
```
一般情况下,将会部署在本地的`8000`端口,可根据终端输出判断端口号。访问 `http://127.0.0.1:端口号` 即可查看本地网页。
4 changes: 4 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ nav:
- 主要: 01-student-discounts/student-discounts.md
- 其他:
- 网易云音乐: 01-student-discounts/others/netease.md
- 国家助学贷款: 01-student-discounts/student-assistance/national-student-loan-FAQ.md
- 搜索引擎:
- 主要: 02-search-platforms/search-platforms.md
- 工具:
Expand All @@ -14,6 +15,7 @@ nav:
- 网络安全:
- 双重身份验证: 03-tools/cyber security/Authenticator.md
- 密码管理: 03-tools/cyber security/password_manage1.md
- 隐私保护: 03-tools/cyber security/privacy.md
- 奇技淫巧:
- 校园跑: 03-tools/qi-ji-yin-qiao/campus-running.md
- 刷课: 03-tools/qi-ji-yin-qiao/pointless-courses.md
Expand All @@ -23,6 +25,8 @@ nav:
- 生活实用小技巧: 05-common-sense-of-life/common-sense-of-life.md
- 就业:
- 企业文化: 06-recruit-exercitation/recruit-exercitation.md
- 方法论:
- 计算机基础技能: 07-computer-basic/computer-basic.md

site_name: AcWiki 大学生的百科全书
site_url: https://acwiki.pages.dev # 预览站点链接,合并成功后需要切换为主仓库链接
Expand Down

0 comments on commit 009fe4a

Please sign in to comment.