doc: update

分离文件
2024-03-19 23:07:33 +08:00
parent 1667899114
commit 14cca1c61c
3 changed files with 159 additions and 127 deletions
@@ -0,0 +1,17 @@
 # Git 简要说明
 # Git 介绍
 To-do
 # 优秀 Git 教程推荐
 - [可视化 Git 教程](https://learngitbranching.js.org/?locale=zh_CN)
 - [微软 Git 教程](https://learn.microsoft.com/zh-cn/training/paths/intro-to-vc-git/)
 - [菜鸟教程](https://www.runoob.com/git/git-tutorial.html)
 # Git 操作建议
 - 强烈建议将仓库 **Clone** 下来进行修改提交等操作
 - **非代码相关请勿上传**，建议在提交前，将非代码文件添加到 `.gitignore` 文件中来忽略提交
 - 请勿上传**非必须**的**大**文件，若需要作为依赖运行，请在 `README.md` 中写明依赖相关的下载操作，也可贴出官方的部署操作相关文档
@@ -0,0 +1,138 @@
 # Markdown 简要说明
 请活用 Markdown 格式，以下为格式示例
 # Markdown Format Test
 ```markdown
 # Markdown Format Test
 ```
 ## 标题 2
 ```markdown
 ## 标题 2
 ```
 ### 标题 3
 ```markdown
 ### 标题 3
 ```
 **这是粗体**
 _这是斜体_
 ~~这是删除线~~
 ```markdown
 **这是粗体**
 _这是斜体_
 ~~这是删除线~~
 ```
 [这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
 ```markdown
 [这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
 ```
 ![这是图片的介绍](https://cdn.isteed.cc/img/2023-summary/thumbnail.webp?这是一张图片的地址)
 ```markdown
 ![这是图片的介绍](https://cdn.isteed.cc/img/2023-summary/thumbnail.webp?这是一张图片的地址)
 ```
 - 这是列表项 1
 - 这是列表项 2
  - 这是嵌套列表项
 ```markdown
 - 这是列表项 1
 - 这是列表项 2
  - 这是嵌套列表项
 ```
 1. 这是有序列表项 1
 2. 这是有序列表项 2
 3. 这是有序列表项 3（不用担心，标准 markdown 语法会自动纠正错误的连续序号）
 ```markdown
 1. 这是有序列表项 1
 2. 这是有序列表项 2
 3. 这是有序列表项 3（不用担心，标准 markdown 语法会自动纠正错误的连续序号）
 ```
 这是 `行内代码`
 ```markdown
 这是 `行内代码`
 ```
 ```python
 # 这是代码块
 # 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
 # 语言说明是可选项，默认是 plaintext（纯文本）
 # 注意，实际不需要输入 \，该字符用于转义
 def hello():
    print("Hello, world!")
 ```
 ```markdown
 \`\`\`python
 # 这是代码块
 # 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
 # 语言说明是可选项，默认是 plaintext（纯文本）
 # 注意，实际不需要输入 \，该字符用于转义
 def hello():
 print("Hello, world!")
 \`\`\`
 ```
 > 这是引用文本
 >
 > > 这是引用文本的引用
 > >
 > > > 以此类推
 ```markdown
 > 这是引用文本
 >
 > > 这是引用文本的引用
 > >
 > > > 以此类推
 ```
 这是表格：
 | 靠左表头 1   |  居中表头 2  |   靠右表头 3 |
 | :----------- | :----------: | -----------: |
 | 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
 ```markdown
 | 靠左表头 1   |  居中表头 2  |   靠右表头 3 |
 | :----------- | :----------: | -----------: |
 | 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
 ```
 分割线：
 ---
 ```markdown
 ---
 ```
 其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
 ```html
 其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
 ```
 # 尾巴
 就先写到这里吧，掌握这些用法应该就足够了，其它的就是撰写规范了，有时间再写写
@@ -2,134 +2,11 @@
 这里支持 Markdown 语法，后缀为 `.md` 的文件均可以直接渲染出来
-其中，目录下的 `README.md` 文件（文件名不区分大小写）将会渲染到仓库对应页面
+其中，任意目录下的 `README.md` 文件（文件名不区分大小写）将会渲染到仓库对应页面
 # Markdown Format Test
 ```markdown
 # Markdown Format Test
 ```
 ## 标题 2
 ```markdown
 ## 标题 2
 ```
 ### 标题 3
 ```markdown
 ### 标题 3
 ```
 **这是粗体**
 _这是斜体_
 ~~这是删除线~~
 ```markdown
 **这是粗体**
 _这是斜体_
 ~~这是删除线~~
 ```
 [这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
 ```markdown
 [这是链接的显示文本](https://www.example.com/这是你要跳转到的链接)
 ```
 ![这是图片的介绍](https://cdn.isteed.cc/img/2023-summary/thumbnail.webp?这是一张图片的地址)
 ```markdown
 ![这是图片的介绍](https://cdn.isteed.cc/img/2023-summary/thumbnail.webp?这是一张图片的地址)
 ```
 - 这是列表项 1
 - 这是列表项 2
  - 这是嵌套列表项
 ```markdown
 - 这是列表项 1
 - 这是列表项 2
  - 这是嵌套列表项
 ```
 1. 这是有序列表项 1
 2. 这是有序列表项 2
 3. 这是有序列表项 3（不用担心，标准 markdown 语法会自动纠正错误的连续序号）
 ```markdown
 1. 这是有序列表项 1
 2. 这是有序列表项 2
 1. 这是有序列表项 3（不用担心，标准 markdown 语法会自动纠正错误的连续序号）
 ```
 这是 `行内代码`
 ```markdown
 这是 `行内代码`
 ```
 ```python
 # 这是代码块
 # 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
 # 语言说明是可选项，默认是 plaintext（纯文本）
 # 注意，实际不需要输入 \，该字符用于转义
 def hello():
    print("Hello, world!")
 ```
 ```markdown
 \`\`\`python
 # 这是代码块
 # 块中的 python 改成你需要的语言就能获得对应的代码高亮功能
 # 语言说明是可选项，默认是 plaintext（纯文本）
 # 注意，实际不需要输入 \，该字符用于转义
 def hello():
 print("Hello, world!")
 \`\`\`
 ```
 > 这是引用文本
 >
 > > 这是引用文本的引用
 > >
 > > > 以此类推
 ```markdown
 > 这是引用文本
 >
 > > 这是引用文本的引用
 > >
 > > > 以此类推
 ```
 这是表格：
 | 靠左表头 1   |  居中表头 2  |   靠右表头 3 |
 | :----------- | :----------: | -----------: |
 | 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
 ```markdown
 | 靠左表头 1   |  居中表头 2  |   靠右表头 3 |
 | :----------- | :----------: | -----------: |
 | 靠左单元格 1 | 居中单元格 2 | 靠右单元格 3 |
 ```
 分割线：
 ---
-```markdown
+本人强烈建议完整阅读以下文本后使用本 Gitea 服务
 ---
 ```
-其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
+- [关于 Markdown](./AboutMarkdown.md)
-
+- [关于 Git](./AboutGit.md)
 ```html
 其实 Markdown 支持<b>直接渲染</b>部分 <i>HTML</i> 语法
 ```
 # 尾巴
 就先写到这里吧，掌握这些用法应该就足够了，其它的就是撰写规范了