Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
bowling233 committed Oct 18, 2023
1 parent d525bc0 commit f43023f
Showing 1 changed file with 2 additions and 12 deletions.
14 changes: 2 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

本地构建与查看:
Expand All @@ -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。
Expand Down

0 comments on commit f43023f

Please sign in to comment.