Skip to content

Commit a49f635

Browse files
committed
使用mkdocs重构文档
1 parent 94fd08b commit a49f635

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+12458
-59
lines changed

.gitattributes

-2
This file was deleted.

.github/workflows/ci.yml

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
name: ci
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- uses: actions/setup-python@v4
14+
with:
15+
python-version: 3.x
16+
- run: pip install mkdocs-material
17+
- run: mkdocs gh-deploy --force

README.md

+1-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
11
# Ren'Py:从入门到入坟
22

3-
**推荐在[文档网站](https://zyksslm.github.io/RenPy-Tutorial/doc/目录.html)中浏览。**
4-
5-
***
6-
7-
[目录](doc/目录.md)
3+
**[《Ren'Py:从入门到入坟》中文文档](https://zyksslm.github.io/RenPy-Tutorial)**

_config.yaml

-11
This file was deleted.

_includes/head.html

-19
This file was deleted.
File renamed without changes.
File renamed without changes.

doc/你好,Ren'Py。.md renamed to docs/你好,Ren'Py。.md

-6
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# 你好,Ren'Py。
42

53
> 合抱之木,生于毫末;百丈之台,起于垒土;千里之行,始于足下。——《老子》
@@ -51,13 +49,11 @@ Ren'Py几乎支持所有视觉小说所应该具有的功能,包括分支故
5149
| 图像 | `WEBP` | |
5250
| 图像 | BMP | |
5351
| 图像 | GIF | 不支持动图 |
54-
| |
5552
| 音频 | OPUS | |
5653
| 音频 | `OGG` | |
5754
| 音频 | FLAC | |
5855
| 音频 | `WAV` | |
5956
| 音频 | `MP3` | |
60-
| |
6157
| 视频(容器) | `WEBM` | 支持VP9、VP8编解码器 |
6258
| 视频(容器) | `OGG` | 支持Theora编解码器 |
6359
| 视频(容器) | MKV | 支持多种编解码器 |
@@ -277,5 +273,3 @@ label start:
277273

278274

279275
那么,在进行完所有的前置准备后,我们就要开始正式学习Ren'Py语法了。
280-
281-
{% endraw %}

doc/变量.md renamed to docs/变量.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# 变量
42

53
## 变量定义
@@ -251,5 +249,3 @@ label start:
251249
# 导入alice存储区中的love变量
252250
from store.Alice import love
253251
```
254-
255-
{% endraw %}

doc/在开始之前.md renamed to docs/在开始之前.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# 在开始之前
42

53
## 说明
@@ -31,5 +29,3 @@ E-mail:`[email protected]`
3129
ZYKsslm
3230

3331
2025/01/14
34-
35-
{% endraw %}

doc/对话.md renamed to docs/对话.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# 对话
42

53
文本剧情是视觉小说类游戏的根本,一切游戏形式都要建立在对话之上。Ren'Py为我们提供了简便快捷的say语句来方便演示对话。
@@ -356,5 +354,3 @@ label start:
356354
"?可恶"
357355
return
358356
```
359-
360-
{% endraw %}

doc/脚本标签.md renamed to docs/脚本标签.md

-4
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
{% raw %}
2-
31
# 脚本标签
42

53
Ren'Py中所有的游戏流程代码都会分别写进数个脚本标签中。脚本标签类似于Python中的函数,用于跳转或调用。
@@ -178,5 +176,3 @@ label .local_label:
178176
```
179177

180178
在上面的代码中,有 `start``globel_label` 全局脚本标签,其分别关联了一个 `.local_label` 局部脚本标签。
181-
182-
{% endraw %}

mkdocs.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
site_name: Ren'Py:从入门到入坟
2+
site_url: https://ZYKsslm.github.io/RenPy-Tutorial
3+
repo_url: https://github.com/ZYKsslm/RenPy-Tutorial
4+
theme:
5+
name: material
6+
language: zh
7+
nav:
8+
- 在开始之前: 在开始之前.md
9+
- 你好,Ren'Py。: 你好,Ren'Py。.md
10+
- 变量: 变量.md
11+
- 脚本标签: 脚本标签.md
12+
- 对话: 对话.md
13+
markdown_extensions:
14+
- pymdownx.highlight:
15+
anchor_linenums: true
16+
line_spans: __span
17+
pygments_lang_class: true
18+
extra_javascript:
19+
- https://cdn.jsdelivr.net/npm/[email protected]/components/prism-core.min.js
20+
- https://cdn.jsdelivr.net/npm/[email protected]/components/prism-python.min.js
21+
- https://cdn.jsdelivr.net/npm/[email protected]/plugins/autoloader/prism-autoloader.min.js
22+
- https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.js
23+
- https://cdn.jsdelivr.net/npm/[email protected]/plugins/copy-to-clipboard/prism-copy-to-clipboard.min.js
24+
extra_css:
25+
- https://cdn.jsdelivr.net/npm/[email protected]/themes/prism-okaidia.min.css
26+
- https://cdn.jsdelivr.net/npm/[email protected]/plugins/line-numbers/prism-line-numbers.min.css
27+

0 commit comments

Comments
 (0)