From f43023f5d5d5f52b8313047fcf469f6babbc0de0 Mon Sep 17 00:00:00 2001 From: Tiandians Date: Wed, 18 Oct 2023 15:12:07 +0800 Subject: [PATCH] docs: README --- README.md | 14 ++------------ 1 file changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index f8111a8..95795c8 100644 --- a/README.md +++ b/README.md @@ -10,16 +10,12 @@ 该仓库已经设置了 GitHub Action,您的每次推送都会自动触发构建与部署,无需在本地执行 `mkdocs gh-deploy` 等操作。 -本网站基于 MkDocs Material 构建,额外使用的插件有: - -- [neoteroi.cards](https://www.neoteroi.dev/mkdocs-plugins/cards/) -- [GLightbox](https://github.com/blueswen/mkdocs-glightbox) -- [mkdocs-heti-plugin](https://github.com/TonyCrane/mkdocs-heti-plugin) +本网站基于 MkDocs Material 构建,额外使用的插件见 `requirements.txt`。 安装 MkDocs 及相关插件: ```bash -pip install mkdocs mkdocs-material neoteroi-mkdocs mkdocs-glightbox mkdocs-heti-plugin +pip install -r requirements.txt ``` 本地构建与查看: @@ -28,12 +24,6 @@ pip install mkdocs mkdocs-material neoteroi-mkdocs mkdocs-glightbox mkdocs-heti- mkdocs serve ``` -手动部署到 GitHub Pages: - -```bash -mkdocs gh-deploy -``` - ## 贡献 我们欢迎辅学学长以及其他同学为我们的网站贡献内容。如果你有任何想法,欢迎提出 issue 或者 PR。