xboxoneresearch/wiki
GitHub: xboxoneresearch/wiki
一个基于 MkDocs 的 Xbox One 研究维基,用于组织与共享主机软硬件技术资料。
Stars: 136 | Forks: 49
# Xbox One 研究维基
[](https://github.com/xboxoneresearch/wiki/actions?query=workflow%3Abuild)
关于 Xbox One 游戏主机系列的各种软硬件信息。
使用 Python 框架 `mkdocs` 来渲染 Markdown 文档。
### 工作流程
## 本地测试
1. 克隆你的维基仓库(**请相应修改 'YourUsername'**):
git clone git@github.com:YourUsername/wiki.git
2. 进入仓库文件夹
cd wiki/
3. 选择以下两种部署方式之一。
### 原生部署
1. 创建并激活 Python 虚拟环境(可能需要依赖 `python3-venv`,请参考 )。
python3 -m venv venv
source venv/bin/activate
2. 安装 `mkdocs` 及其依赖项:
pip install -r requirements.txt
3. 编辑文档并使用以下命令验证:
1. 启动文档服务():
mkdocs serve --strict
2. 构建文档:
mkdocs build --strict
### Docker 部署
1. 启动 Docker 容器:
docker compose up
2. 访问 。
3. 进行修改,然后验证格式和链接是否正确。
标签:Docker 部署, GitHub Actions, Markdown 文档, mkdocs, Python 框架, Xbox One, 安全可观测性, 开发运维, 开源框架, 技术文档, 持续集成, 文档网站, 本地部署, 游戏机, 源码托管, 版本控制, 研究维基, 硬件, 网络运维, 自动笔记, 虚拟环境, 请求拦截, 软件, 逆向工具, 静态站点生成