NachtgeistW / YukariFans

YukariFans_MkDocs

介绍

泛VOICEROID工具导航站

因为是节雨竹的仓库所以就不写俏皮话了 --DE

这种事情随便啦

软件架构

使用MkDocs方便地将多个Markdown文件生成静态网页。 使用的主题是MkDocs-Material, 英文参考文档 (中文的太旧了)。

使用的插件的作用说明

插件的作用全写在mkdocs.yml配置文件里了

安装教程

1. 安装Python3.9
2. 使用pip install -r requirements.txt安装Python依赖库

其中 jieba库 是为了让搜索功能支持中文的进行分词的库，具体使用参考https://zhuanlan.zhihu.com/p/411854801

• 如果电脑中已经安装了不同版本的Python, 或想方便地从零开始安装Python, 推荐用Miniconda/Conda进行Python版本管理。
  • 参考Miniconda安装及使用--小白上路
  • 创建需要的环境：conda create -n name_of_this_environment python=3.9.5
  • Miniconda的常用指令

使用说明

如何在本地查看页面

1. 进入YukariFans_Mkdocs/YukariFans目录（mkdocs.yml同级目录）
2. 使用mkdocs serve启动本地服务器
3. 通过浏览器访问给出的地址（默认http://127.0.0.1:8000/）

如何将页面上传

1. 进入YukariFans_Mkdocs/YukariFans目录（mkdocs.yml同级目录）
2. 使用mkdocs gh-deploy 来上传文档到gitee-page中