Wiki 内容编写格式与规则

重要 :本站不允许非作者的全文转载,每篇内容版权归作者所有,欢迎外部作者将内容投稿到本站。
本站支持两种投稿方式:

  1. 内容投稿,直接把内容创建一个 md 文件发布到本站,能够进行全文搜索、贡献统计。
  2. 链接投稿,能够把一篇外部链接的内容发布到本站,可以进行分类和添加标签,点击会跳转到指定的链接。

内容投稿

提交新的 Wiki 词条需要在 UnrealCommunity/commit_wiki 中创建一个 issue,Wiki 格式已创建模版,在 issues 页面选择“创建新的 Wiki 内容”即可,当使用这种方式投稿并被接受一次之后会被添加 Authors 权限,就能够点击页面右上角的 Edit/New 进行在线创建会让编辑。

Unreal Engine Wiki 的文档编写规则与组织方式:

  1. 每个 Wiki 页面是一个独立的 md 文档
  2. 使用 categories 进行分类
  3. 添加合适的 Tag
  4. 通过文档所在的文件夹进行自动分类
  5. 指定作者名字以及链接
  6. 能够指定文章使用的引擎版本
  7. 能够指定自定义导流 / 打赏二维码
  8. 能够自定义 copyright 以及备份链接信息
  9. 能够控制是否开启评论功能
  10. 能够添加外部链接引用

可以预览文章效果:Profiling for UE,配置模板(在 github 上创建 issue 时会自动创建):

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
---
title: # 标题
date: 2021-06-29 22:32:01 # 创建时间
toc: true # 开启目录
categories: # 分类,可以指定多个,用于进行目录分类
- 父分类
- 子分类
tag: # 标签可以指定多个(每行一个)
-
comments: true # 开启评论
ue_version: UE4.25 # 文章使用的引擎版本
author: # 作者信息,会显示在贡献者列表
name: # 名字
site_addr: # 网站链接
avatar_image: # 头像图片链接,如果为空则默认使用 github 头像
github_id: # github 账户 ID
zhihu_addr: # 知乎链接
email: # 邮件地址
wechat_image: # 微信二维码图片地址
postQR:
enable: false # 开启文章末尾二维码
image: # 二维码链接
info: # 显示文字
copyright: # 文章末尾的版权信息
enable: true
history: true # 是否可查看文章编辑历史、RAW 文本
license: CC BY-NC-SA 4.0 # 文章的授权协议
backupAddr: # 文章的备份链接
---

<!-- WIKI 内容 -->

注意需要填写贡献者信息(author),如果不指定 avatar_image 图片链接,则会默认获取 github 账户头像。

本站的 Wiki 的文件存储在 source/_posts/ 下,Title 为文件名。

链接投稿

为了支持已存在发布于其他平台的内容,我开发了链接投稿的功能,按照格式要求提交到 UnrealCommunity/commit_wiki 的 issues 即可。

添加外部链接并进行分类和加标签:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
external:
-
title: UE 开发笔记:Android 篇
link: https://imzlp.com/posts/17996/
describtion: #文章的简要描述,文字在一行内
categories:
- Mobile
- Android
tags:
- Mobile
- Android
- 外部链接测试
-
title: # 文章 2
link: # 文章链接
categories:
- # 分类
tags:
- 标签

同样能够被本站的分类、标签中查看、以及搜索(仅限标题),点击链接会自动跳转到所指定的链接页面。

发布之后就会在分类和标签页面显示:
分类
标签云
标签
搜索

插入 b 站视频

md 中可以直接插入 html 代码:

1
<iframe src="//player.bilibili.com/player.html?aid=583305972&bvid=BV1Tz4y197tR&cid=209073526&page=1" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe>

但是推荐使用{% bilibili your_video_id %},能根据屏幕自适应:

内容要求

需要保证 Wiki 内容在测试环境的准确性,所有内容应该在本地测试通过,不允许提交未被验证的内容。

未完,待补充。