|
1 | | -# python-入门文档 |
| 1 | +# Python 入门文档 |
2 | 2 |
|
3 | | -The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume) |
| 3 | +这是一个新手友好的 Python 3 入门文档, |
4 | 4 |
|
5 | | -## Install |
| 5 | +要阅读本文档,请前往 <https://python.yxzl.dev/> |
6 | 6 |
|
7 | | -```sh |
8 | | -pnpm i |
9 | | -``` |
10 | | -::: |
| 7 | +更多内容: |
11 | 8 |
|
12 | | -## Usage |
13 | | - |
14 | | -```sh |
15 | | -# start dev server |
16 | | -pnpm docs:dev |
17 | | -# build for production |
18 | | -pnpm docs:build |
19 | | -# preview production build in local |
20 | | -pnpm docs:preview |
21 | | -# update vuepress and theme |
22 | | -pnpm vp-update |
23 | | -``` |
24 | | -::: |
25 | | - |
26 | | -## Deploy to GitHub Pages |
27 | | - |
28 | | -The plume theme has been created with GitHub Actions: `.github/workflows/docs-deploy.yml`. You also need to make the following settings in the GitHub repository: |
29 | | - |
30 | | -- [ ] `settings > Actions > General`, Scroll to the bottom of the page, under `Workflow permissions`, check `Read and write permissions`, and click the save button. |
31 | | - |
32 | | -- [ ] `settings > Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button. |
33 | | - (The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.) |
34 | | - |
35 | | -- [ ] Modify the `base` option in `docs/.vuepress/config.ts`: |
36 | | - - If you are planning to deploy to `https://<USERNAME>.github.io/`, you can skip this step as `base` defaults to `"/"`. |
37 | | - - If you are planning to deploy to `https://<USERNAME>.github.io/<REPO>/`, meaning your repository URL is `https://github.com/<USERNAME>/<REPO>`, set `base` to `"/<REPO>/"`. |
38 | | - |
39 | | -To customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages) |
40 | | - |
41 | | -## Documents |
42 | | - |
43 | | -- [vuepress](https://vuepress.vuejs.org/) |
44 | | -- [vuepress-theme-plume](https://theme-plume.vuejs.press/) |
| 9 | +- [项目介绍](https://python.yxzl.dev/5njxhpwr/) |
| 10 | +- [贡献者信息](https://python.yxzl.dev/taqbzfxf/) |
| 11 | +- [参考和引用列表](https://python.yxzl.dev/fijhd6jw/) |
0 commit comments