尝试引入 MarkdownLint 规范格式 (#285)

* markdownlint

* try to format docs
This commit is contained in:
SB-Reborn 2024-10-01 00:00:22 +08:00 committed by GitHub
parent b8a0daafc5
commit 85d40b7af6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
11 changed files with 86 additions and 75 deletions

View File

@ -175,7 +175,6 @@ SRV 记录,使用二级域名记录了端口的信息,使用 SRV 可以隐
:::
## AAAA 记录
将域名指向一个 IPV6 地址。和 A 记录的不同之处是AAAA 记录专门用来指向 IPv6 地址,不能指向 IPv4 地址。同理A 记录也只能指向 IPv4 地址,不能指向 IPv6 地址这也意味着你如果要为服务器的IPv6地址也绑定一个域名你就必须要再创建一条 AAAA 记录。
@ -231,7 +230,7 @@ DDNS 服务必须需要一个域名才能开始搭建。运行 DDNS 服务的软
由于读者可能使用各种各样的域名注册商,而且限于篇幅,本文仅提供 Windows 系统、腾讯云 DNS(DNSPod)和 ddns-go 配合使用的教程。其他注册商和操作系统的配置方法大同小异,读者们灵活变通即可,有不懂的地方善用搜索引擎搜索。
1. 前往 https://github.com/jeessy2/ddns-go/releases 下载最新版的 ddns-go 安装包。
1. 前往 <https://github.com/jeessy2/ddns-go/releases> 下载最新版的 ddns-go 安装包。
2. 将安装包(就是下载的那个压缩包)解压到一个不会被自己误删除的位置(如果你不知道哪里自己不会误删除,就直接解压到文件管理器左侧的文档那个文件夹)。
3. 在 `ddns-go.exe` 所在的同级目录[打开 Powershell](https://www.bing.com/search?q=windows%E6%80%8E%E4%B9%88%E5%9C%A8%E6%96%87%E4%BB%B6%E5%A4%B9%E4%B8%AD%E6%89%93%E5%BC%80powershell&qs=n&form=QBRE&sp=-1&lq=0&pq=windows%E6%80%8E%E4%B9%88%E5%9C%A8%E6%96%87%E4%BB%B6%E5%A4%B9%E4%B8%AD%E6%89%93%E5%BC%80powershell&sc=0-26&sk=&cvid=ED4A3EA564234CA2A72F233F64580905&ghsh=0&ghacc=0&ghpl=)。
4. 执行 `./ddns-go.exe`

View File

@ -51,6 +51,7 @@ Repository name填 你的用户名.github.io
如果你做到这一步至此你的网站已经是搭建完成了。但是由于某些特别的原因,大陆访问 Github Pages 服务比较困难。为了保证不懂技术的普通玩家们顺利访你的服务器官网,可以选择以下方式
### 2\.cloudflare saas回源
:::warning
注意!如果想要域名访问要先在github项目的settings-pages-Custom domain 添加域名
@ -89,7 +90,6 @@ Repository name填 你的用户名.github.io
cf-cname.xingpingcn.top 不需要开启小黄云
![微信图片_20240916092435.png](_images/open-web-photo/close-yellow-cloud.png)
然后来到你的主域名 添加DNS记录
添加一个类型为CNAME 名称为输入你刚刚在自定义主机名时输入的前缀 内容为cdn.你的回源域名
@ -102,7 +102,7 @@ cf-cname.xingpingcn.top 不需要开启小黄云
:::warning
不要使用自己家里的宽带搭建服务器官网!由于家宽无固定 IP无法进行备案。目前已有因使用家宽建站而受到运营商警告的案例详见 https://www.zhihu.com/question/440645939/answer/3228728304
不要使用自己家里的宽带搭建服务器官网!由于家宽无固定 IP无法进行备案。目前已有因使用家宽建站而受到运营商警告的案例详见 <https://www.zhihu.com/question/440645939/answer/3228728304>
:::
@ -115,6 +115,7 @@ cf-cname.xingpingcn.top 不需要开启小黄云
#### 准备工作
要为网站备案,需要进行以下准备:
1. 一台拥有固定 IP 的云服务器,或一条拥有固定 IP 的商用宽带
2. 已经实名认证、用于网站访问的域名
3. 服务器的经营许可证等相关证件或自己的身份证等证件。
@ -133,7 +134,7 @@ cf-cname.xingpingcn.top 不需要开启小黄云
提交后,需要经过一段时间的审核,全程在 1 到 22 天。部分服务器运营商会自行先对你的信息进行审核,确保其能够顺利通过管局审核后再提交到管局。审核通过后,你将会获得 **ICP 备案号**作为服务器官网的备案证明。
备案通过后网站上线时,你需要根据相关规定在网站上标注备案信息。并链接至工信部备案网址 http://www.beian.miit.gov.cn 供用户查询。技术上可通过以下方法实现:
备案通过后网站上线时,你需要根据相关规定在网站上标注备案信息。并链接至工信部备案网址 <http://www.beian.miit.gov.cn> 供用户查询。技术上可通过以下方法实现:
在网站首页的 html 文件中,在`<body>`标签内最底部添加以下代码:
@ -159,7 +160,7 @@ cf-cname.xingpingcn.top 不需要开启小黄云
### 在 Windows 系统上搭建网站服务
在浏览器中输入 https://nginx.org/en/
在浏览器中输入 <https://nginx.org/en/>
然后点击右边的download
@ -225,7 +226,3 @@ cf-cname.xingpingcn.top 不需要开启小黄云
在这里附上源码下载[点击下载](https://b2.mcdogserver.top/1.zip)
如果你觉得这个源码不适合你,或者是你不想用别人的源码,你可以尝试去自学。这里就不附上自学的教程了

View File

@ -37,6 +37,7 @@ sidebar_position: 100
## 建设阶段
- [ ] 新增文案教程,和美术教程折叠在侧边栏同一项下面
>
> - 统一文字排版,风格
> - 统一语言,不要让玩家看到还没汉化的信息
> - 统一写法同时有iamm某物品库应该选择其中一个来写物品
@ -103,6 +104,7 @@ sidebar_position: 100
~~什么玩意~~
### 玩家管理
- [ ] 服务器群
- [ ] 白名单制度
- [ ] 我的世界wiki
@ -117,6 +119,7 @@ sidebar_position: 100
- [ ] 玩家反馈
### 管理团队
- [ ] 招募团队
- [ ] 人员分工
- [ ] 时间安排
@ -125,12 +128,14 @@ sidebar_position: 100
- [ ] 不要加入无意义的纠纷
### 宣传
- [ ] 主流可用于宣传的平台及其利弊
- [ ] 广告学
- [ ] 梗的发展与传播
- [ ] 宣传片的制作流程
### 资金管理
- [ ] 可持续发展
- [ ] 投资心理学

View File

@ -40,6 +40,7 @@ MOD 服务端
### 混合服务端(CatServer 等)
#### CatServer
| Minecraft 版本 | 最低版本 | 推荐版本 |
|-----------------|---------|---------|
| 1.12.2 | Java 8 | Java 8 |
@ -47,6 +48,7 @@ MOD 服务端
| 1.18.2 | Java 17 | Java 17 |
#### Mohist
| Minecraft 版本 | 最低版本 | 推荐版本 |
|-----------------|---------|---------|
| 1.7.10 | Java 8 | Java 8 |
@ -54,6 +56,7 @@ MOD 服务端
| 1.18.2 - 1.20.2 | Java 17 | Java 17 |
#### SpongeForge
| Minecraft 版本 | 最低版本 | 推荐版本 |
|-----------------|---------|---------|
| 1.8 - 1.12.2 | Java 8 | Java 8 |
@ -61,7 +64,6 @@ MOD 服务端
| 1.19.4 | Java 17 | Java 17 |
| 1.20.6 1.21.1 | Java 21 | Java 21 |
## 直接下载
:::warning
@ -107,7 +109,7 @@ MOD 服务端
你可以在下方链接直接下载 Java 8
https://www.java.com/zh-CN/download/
<https://www.java.com/zh-CN/download/>
</details>
如果你想进行 JVM 优化,请看 [JVM 优化](https://yizhan.wiki/NitWikit/Java/optimize/jvm)
@ -139,11 +141,12 @@ java -version
<details>
<summary>食用方式:</summary>
1. 打开此链接下载 AJI: https://github.com/Lafcadia/AJI/releases/download/v0.0.2/main.exe
1. 打开此链接下载 AJI: <https://github.com/Lafcadia/AJI/releases/download/v0.0.2/main.exe>
2. 下好了,右键选择以管理员权限打开(如果不以管理员权限打开就无法绑定 Java 环境变量,虽然不给管理员权限程序也能正常运行,并安装 Java但可能会在后续阶段出现问题)
3. ![示意图](https://github.com/user-attachments/assets/28035c47-d34b-4b38-b895-29f38366bef9)
4. 选择合适的版本的 Java点击 `Install Java`,下载。
5. 不要关闭窗口,直到下方的提示栏从 `Installing...` 变为 `Complete.`
</details>
## FAQ

View File

@ -4,7 +4,7 @@ slug: /services
sidebar_position: 5
---
# 笨蛋服务!
# 笨蛋服务
这些服务由赛博菩萨 cloudflare 和 lilingfeng 搭建,完全免费提供!
@ -28,30 +28,30 @@ sidebar_position: 5
<details>
<summary>公共域名列表</summary>
* mcfun.us.kg
* nitwikit.us.kg
* yizhan.us.kg
* playmc.imc.rip
* mc.imc.rip
* llf.myredirect.us
* mc.lookin.at
* mcfun.findhere.org
* mcfun.lookin.at
* nitwikit.myfw.us
* playmc.lookin.at
* playmc.myfw.us
* playmc.rr.nu
* yizhan.findhere.org
* yizhan.myfw.us
* yizhan.rr.nu
* (还有更多!)
- mcfun.us.kg
- nitwikit.us.kg
- yizhan.us.kg
- playmc.imc.rip
- mc.imc.rip
- llf.myredirect.us
- mc.lookin.at
- mcfun.findhere.org
- mcfun.lookin.at
- nitwikit.myfw.us
- playmc.lookin.at
- playmc.myfw.us
- playmc.rr.nu
- yizhan.findhere.org
- yizhan.myfw.us
- yizhan.rr.nu
- (还有更多!)
</details>
<details>
<summary>限制注册公共域名</summary>
* wsdj.in
- wsdj.in
需要群等级50级以上才可以注册
@ -73,8 +73,8 @@ sidebar_position: 5
然后联系lilingfeng(3644147215),将你要的域名,子域名,以及需要解析到的目标(SRV需要端口)发过来,请确保你需要的子域名满足以下条件
* 只有数字和字母
* 没被别人用
- 只有数字和字母
- 没被别人用
然后静待llf回复**不要问好了没有这些无意义话语**
@ -120,20 +120,20 @@ mcping <服务器地址>
### `帮助`
返回 https://yizhan.wiki/NitWikit/services/
返回 <https://yizhan.wiki/NitWikit/services/>
### `正确提问`
返回消息 https://yizhan.wiki/NitWikit/start/%E5%90%91%E5%A4%A7%E4%BD%AC%E6%B1%82%E5%8A%A9
返回消息 <https://yizhan.wiki/NitWikit/start/%E5%90%91%E5%A4%A7%E4%BD%AC%E6%B1%82%E5%8A%A9>
### `搜索`
返回消息 https://yizhan.wiki/NitWikit/search?q=
返回消息 <https://yizhan.wiki/NitWikit/search?q=>
### `核心`
返回消息
📦 单端 https://yizhan.wiki/NitWikit/Java/start/server-core-choose
📦 单端 <https://yizhan.wiki/NitWikit/Java/start/server-core-choose>
📦 跨服端 https://yizhan.wiki/NitWikit/Java/advance/cross-server/server-core-choose
📦 跨服端 <https://yizhan.wiki/NitWikit/Java/advance/cross-server/server-core-choose>

View File

@ -10,6 +10,7 @@ sidebar_position: 2
:::warning
请不要再使用 Windows 自带的记事本和写字板了。这些文本编辑器通常有以下问题:
1. 可能造成文件编码发生改变。小白操作时尤其容易出现,部分情况下用记事本和写字板保存文件后文件因编码改变等问题而无法服务器读取。
2. 无法察觉到格式错误。有时编辑文件时会因为不小心删除或添加了些符号,导致配置文件语法错误,服务器无法识别。本文介绍的文本编辑器均能识别出这些格式错误并做出提示和警告,然而记事本和写字板却不具备这些功能。
3. 无法准确地辨认缩进等格式。这些文本编辑器由于默认不使用 [等宽字体](https://baike.baidu.com/item/%E7%AD%89%E5%AE%BD%E5%AD%97%E4%BD%93/8434037) 显示文字,导致其显示效果与原格式存在差异。
@ -44,7 +45,7 @@ VSCode 会在未保存的文件后标记一个白点,提示你这个文件编
缺点是启动速度可能不是很快,不过非常适合新手使用。(已经算是比较快的了。)
官网链接https://code.visualstudio.com/
官网链接:<https://code.visualstudio.com/>
[下载龟速怎么办](https://cn.bing.com/search?q=vscode%E4%B8%8B%E8%BD%BD%E9%BE%9F%E9%80%9F%E6%80%8E%E4%B9%88%E5%8A%9E)
@ -61,7 +62,7 @@ VSCode 会在未保存的文件后标记一个白点,提示你这个文件编
我不太喜欢的一点是保存文件时,对非激活的用户有一定概率弹出个窗口,提示你去付费支持(可以选择不支持)。但这依旧是一个非常优秀的文本编辑器。
官网链接https://www.sublimetext.com/
官网链接:<https://www.sublimetext.com/>
[如何汉化](https://cn.bing.com/search?q=sublime+text%e6%b1%89%e5%8c%96&qs=SC&pq=sublimetext&sk=HS1SC5&sc=10-11&cvid=19623440FA3646E0BEBECEED995CFCAF&FORM=QBRE&sp=7&lq=0)
@ -74,7 +75,7 @@ VSCode 会在未保存的文件后标记一个白点,提示你这个文件编
![Kate](https://kate-editor.org/images/konsole.png)
官网链接https://kate-editor.org/zh-cn/
官网链接:<https://kate-editor.org/zh-cn/>
开源,跨平台,也可以秒开文件。
@ -89,9 +90,9 @@ VSCode 会在未保存的文件后标记一个白点,提示你这个文件编
也是一个比较不错的文本编辑器。要求:**Windows 8 +**。
官网链接: https://rizonesoft.com/downloads/notepad3/
官网链接: <https://rizonesoft.com/downloads/notepad3/>
GitHub: https://github.com/rizonesoft/Notepad3
GitHub: <https://github.com/rizonesoft/Notepad3>
</details>
@ -139,7 +140,7 @@ dizhi 08年奥运会 声称(仅声明,但还是挺过分的)不同意它的政
![HbuilderX](_images/HbuilderX展示.png)
官网链接https://dcloud.io/hbuilderx.html
官网链接:<https://dcloud.io/hbuilderx.html>
一个国产的文本编辑器。
@ -156,7 +157,7 @@ dizhi 08年奥运会 声称(仅声明,但还是挺过分的)不同意它的政
![](https://www.geany.org/media/uploads/screenshots/homepage/.thumbnails/geany_dark_2019-05-20.png/geany_dark_2019-05-20-500x0.png)
官网链接https://www.geany.org/
官网链接:<https://www.geany.org/>
</details>

View File

@ -164,6 +164,7 @@ MC 中方块的尺寸是 16x16x16 像素,对应 1 立方米,单个像素长
![](_images/海洋之心.jpg)
### 线条 & 形状
「锯齿」是像素画中由于线条/边缘未经润色、或缺少抗锯齿而出现的形状(无意中产生的边角),直线的步长需要保持一致,这样看起来就不会过于粗糙。
除了直线,曲线中也会出现锯齿,通常表现为棱角或对角线的形式(用于表现圆形)。
@ -173,6 +174,7 @@ MC 中方块的尺寸是 16x16x16 像素,对应 1 立方米,单个像素长
![](_images/直线与曲线中的锯齿表现.jpg)
### 物品纹理
所有绘制的物品都应该适配 16x16 网格。
首先用中间色调画出物品的基础形状,并给它加上一个深色的轮廓
@ -188,6 +190,7 @@ MC 中方块的尺寸是 16x16x16 像素,对应 1 立方米,单个像素长
![](_images/物品纹理.jpg)
### 方块纹理
对方块纹理的要求不同于物品,方块纹理既需要考虑其单独出现,也需要考虑相邻放置的情况。将多个同类方块紧贴放置的行为称作「平铺」,如果在视觉上能感到纹理中有部分显著重复、凸显出平铺的图案,这种情况就需要加以纠正了。
你可以直接用 Blockbench 制作方块纹理(使用 Paint 模式)、或只是用于实时 3D 预览你在外部图像编辑器创建的纹理。如果你想预览平铺的效果,最推荐的方法是创建一面 3x3 方块构成的墙。
@ -213,9 +216,3 @@ MC 中方块的尺寸是 16x16x16 像素,对应 1 立方米,单个像素长
生成纹理模板 > 画出颜色与高光阴影 > 添加更多细节 > 表现出材质效果
![](_images/实体纹理.jpg)

View File

@ -99,7 +99,6 @@ tar -zxf mcsmanager_linux_release.tar.gz
:::
```shell
# 安装依赖库
./install.sh

View File

@ -54,10 +54,12 @@ sidebar_position: 7
2. 礼貌用语
例如,你应该:
- 使用一定的称呼:`请问大佬们我的 xxx 插件报错 NullPointerException 该怎么办呢?`
- 使用敬语:`打扰一下,我最近服务器总是报错 The server has not responded for 35 seconds! 请问有人知道怎么回事吗?`
而不能:
- 开门见山:`服务器报错是这个 C++ Exception: std::optional<class std::system_error> 是啥情况`
- 发言不友好:`你不知道可以不说话,别在这浪费我时间`
- 斥责他人:`你是不不会写插件啊,这插件怎么能开服就报错呢`
@ -65,10 +67,12 @@ sidebar_position: 7
3. 明确遇到的问题,到**对应群**里问
例如,你应该:
- 某插件出现不适配问题后在名为“我的世界服主交流群”的开服综合交流群里提问 `请问在升级 paper1.20.4 之后遇到 xxx 插件不适配应该怎么办?`
- 某小众插件与 Leaves 核心出现兼容性问题后在该插件官方交流群里提问 `作者大大,你的 xxx 插件和 leaves 核心是不是有兼容性问题呢?`
而不能:
- PowerNukkitX 核心相关问题到 LeviLemina 交流群里提问
- 路由器配置相关问题到某插件官方交流群里提问
- 卡服问题到其他游戏交流群里提问
@ -76,10 +80,12 @@ sidebar_position: 7
4. 提到服务器环境
例如,你应该:
- `大佬们我是 1.16.5 catserver 服务器,遇到了 xxx 问题`
- `最近我升级到了 1.21 paper 核心,玩家反应 xxx 有人有类似的问题吗?`
而不能:
- 仅给出插件名和报错却不给出服务端版本等信息:`大佬们有没有人知道我这个 xxx 插件怎么加载不了,报错 NoClassDefFoundError`
- 仅附上报错信息却没有给出任何服务端版本、加载器版本、插件列表等信息:`有没有大佬能帮我看看这个崩服是为什么什么也不干跑一跑图就崩ll加载器`
@ -87,9 +93,10 @@ sidebar_position: 7
## 看完 Wiki 再问
Wiki 就是让你解决常见问题的,不看这玩意儿就在那瞎问只会获得 `滚过去看 wiki ` 回复。
Wiki 就是让你解决常见问题的,不看这玩意儿就在那瞎问只会获得 `滚过去看 wiki` 回复。
几乎所有的软件都会附上 Wiki它们一般位于
- 插件的 README 文件(GitHub 主页往下翻一般就是)
- 插件作者在社交媒体发布的视频文章等或自行搭建的网站(入口一般可以在插件的论坛介绍页、官网、 README 中找到)
- 插件作者在即时通讯软件上发布的视频文章等(比如有的插件作者会让你加他的 QQ 群,之后把使用文档放在群文件或群公告里)
@ -154,22 +161,22 @@ Wiki 就是让你解决常见问题的,不看这玩意儿就在那瞎问只会
<details>
<summary>其他可用的网站</summary>
- https://pastes.dev/
- https://paste.fastmirror.net/
- https://n0paste.tk/
- https://www.paste.lv/
- https://nekobin.com/
- https://note.ms/dwlg
- https://paste.gg/
- https://bytebin.lucko.me/
- https://netcut.cn/
- https://cl1p.cn/
- https://jiantieban.cn/
- https://www.verybin.com/
- https://ykjtb.com/
- https://airportal.cn/
- https://toolight.cn/text/paste
- https://nick-running.github.io/easy-tools/clipboard.html
- <https://pastes.dev/>
- <https://paste.fastmirror.net/>
- <https://n0paste.tk/>
- <https://www.paste.lv/>
- <https://nekobin.com/>
- <https://note.ms/dwlg>
- <https://paste.gg/>
- <https://bytebin.lucko.me/>
- <https://netcut.cn/>
- <https://cl1p.cn/>
- <https://jiantieban.cn/>
- <https://www.verybin.com/>
- <https://ykjtb.com/>
- <https://airportal.cn/>
- <https://toolight.cn/text/paste>
- <https://nick-running.github.io/easy-tools/clipboard.html>
</details>
@ -179,7 +186,7 @@ Wiki 就是让你解决常见问题的,不看这玩意儿就在那瞎问只会
:::
**经典如何提问: https://settingdust.gitbook.io/stop-ask-questions-the-stupid-ways/**
**经典如何提问: <https://settingdust.gitbook.io/stop-ask-questions-the-stupid-ways/>**
## 经典老图

View File

@ -11,6 +11,8 @@
"clear": "docusaurus clear",
"serve": "docusaurus serve",
"test": "docusaurus build && docusaurus serve",
"format": "markdownlint-cli2 --fix docs/**/*.md",
"format:check": "markdownlint-cli2 docs*/**/*.md",
"write-translations": "docusaurus write-translations",
"write-heading-ids": "docusaurus write-heading-ids"
},
@ -31,7 +33,8 @@
},
"devDependencies": {
"@docusaurus/module-type-aliases": "^3.5.2",
"@docusaurus/types": "^3.5.2"
"@docusaurus/types": "^3.5.2",
"markdownlint-cli2": "^0.14.0"
},
"browserslist": {
"production": [