Add markdownlint

Add `markdownlint` linter and fix issues. Config is based on the one
from electron's repo with a few rules relaxed.

Author: silverwind

.editorconfig

@@ -26,6 +26,3 @@ indent_style = tab
 
 [*.svg]
 insert_final_newline = false
-
-[*.md]
-trim_trailing_whitespace = false

.markdownlint.yaml

@@ -0,0 +1,18 @@
+commands-show-output: false
+fenced-code-language: false
+first-line-h1: false
+header-increment: false
+line-length: {code_blocks: false, tables: false, stern: true, line_length: -1}
+no-alt-text: false
+no-bare-urls: false
+no-blanks-blockquote: false
+no-duplicate-header: {allow_different_nesting: true}
+no-emphasis-as-header: false
+no-empty-links: false
+no-hard-tabs: {code_blocks: false}
+no-inline-html: false
+no-space-in-code: false
+no-space-in-emphasis: false
+no-trailing-punctuation: false
+no-trailing-spaces: {br_spaces: 0}
+single-h1: false

Makefile

@@ -313,6 +313,7 @@ lint-frontend: node_modules
 	npx eslint --color --max-warnings=0 --ext js,vue web_src/js build *.config.js docs/assets/js
 	npx stylelint --color --max-warnings=0 web_src/less
 	npx spectral lint -q -F hint $(SWAGGER_SPEC)
+	npx markdownlint docs
 
 .PHONY: lint-backend
 lint-backend: golangci-lint vet editorconfig-checker

docs/content/doc/advanced/clone-filter.en-us.md

@@ -30,7 +30,6 @@ see Git version of the server.
 By default, clone filters are enabled, unless `DISABLE_PARTIAL_CLONE` under
 `[git]` is set to `true`.
 
-
 See [GitHub blog post: Get up to speed with partial clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/)
 for common use cases of clone filters (blobless and treeless clones), and
 [GitLab docs for partial clone](https://docs.gitlab.com/ee/topics/git/partial_clone.html)

docs/content/doc/advanced/config-cheat-sheet.en-us.md

@@ -173,8 +173,8 @@ menu:
 - `ADAPTER`: **memory**: 缓存引擎，可以为 `memory`, `redis` 或 `memcache`。
 - `INTERVAL`: **60**: 只对内存缓存有效，GC间隔，单位秒。
 - `HOST`: **\<empty\>**: 针对redis和memcache有效，主机地址和端口。
-    - Redis: `network=tcp,addr=127.0.0.1:6379,password=macaron,db=0,pool_size=100,idle_timeout=180`
-    - Memache: `127.0.0.1:9090;127.0.0.1:9091`
+  - Redis: `network=tcp,addr=127.0.0.1:6379,password=macaron,db=0,pool_size=100,idle_timeout=180`
+  - Memache: `127.0.0.1:9090;127.0.0.1:9091`
 - `ITEM_TTL`: **16h**: 缓存项目失效时间，设置为 -1 则禁用缓存。
 
 ## Cache - LastCommitCache settings (`cache.last_commit`)
@@ -239,7 +239,6 @@ file -I test01.xls
 test01.xls: application/vnd.ms-excel; charset=binary
 ```
 
-
 ## Log (`log`)
 
 - `ROOT_PATH`: 日志文件根目录。
@@ -251,10 +250,9 @@ test01.xls: application/vnd.ms-excel; charset=binary
 - `ENABLED`: 是否在后台运行定期任务。
 - `RUN_AT_START`: 是否启动时自动运行。
 - `SCHEDULE` 所接受的格式
-   - 完整 crontab 控制, 例如 `* * * * * ?`
-   - 描述符, 例如 `@midnight`, `@every 1h30m` ...
-   - 更多细节参见 [cron api文档](https://pkg.go.dev/github.com/gogs/[email protected])
-
+  - 完整 crontab 控制, 例如 `* * * * * ?`
+  - 描述符, 例如 `@midnight`, `@every 1h30m` ...
+  - 更多细节参见 [cron api文档](https://pkg.go.dev/github.com/gogs/[email protected])
 
 ### Cron - Update Mirrors (`cron.update_mirrors`)
 
@@ -440,6 +438,7 @@ Repository archive 的存储配置。 如果 `STORAGE_TYPE` 为空，则此配
 - `PROXY_HOSTS`: **\<empty\>**: 逗号分隔的多个需要代理的网址，支持 * 号匹配符号， ** 表示匹配所有网站
 
 i.e.
+
 ```ini
 PROXY_ENABLED = true
 PROXY_URL = socks://127.0.0.1:1080

docs/content/doc/advanced/config-cheat-sheet.zh-cn.md

@@ -149,13 +149,13 @@ copy javascript files from https://gitea.com/davidsvantesson/plantuml-code-highl
 
 You can then add blocks like the following to your markdown:
 
-    ```plantuml
-        Alice -> Bob: Authentication Request
-        Bob --> Alice: Authentication Response
+```plantuml
+Alice -> Bob: Authentication Request
+Bob --> Alice: Authentication Response
 
-        Alice -> Bob: Another authentication Request
-        Alice <-- Bob: Another authentication Response
-    ```
+Alice -> Bob: Another authentication Request
+Alice <-- Bob: Another authentication Response
+```
 
 The script will detect tags with `class="language-plantuml"`, but you can change this by providing a second argument to `parsePlantumlCodeBlocks`.
 

docs/content/doc/advanced/customizing-gitea.en-us.md

@@ -25,31 +25,31 @@ GITEA_CUSTOM=/home/gitea/custom ./gitea web
 
 因为 Gitea 使用 Go 语言编写，因此它使用了一些相关的 Go 的配置参数：
 
-  * `GOOS`
-  * `GOARCH`
-  * [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
+* `GOOS`
+* `GOARCH`
+* [`GOPATH`](https://golang.org/cmd/go/#hdr-GOPATH_environment_variable)
 
 您可以在[官方文档](https://golang.org/cmd/go/#hdr-Environment_variables)中查阅这些配置参数的详细信息。
 
 ## Gitea 的文件目录
 
-  * `GITEA_WORK_DIR`：工作目录的绝对路径
-  * `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录
-  * `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代
-  * `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代
+* `GITEA_WORK_DIR`：工作目录的绝对路径
+* `GITEA_CUSTOM`：默认情况下 Gitea 使用默认目录 `GITEA_WORK_DIR`/custom，您可以使用这个参数来配置 *custom* 目录
+* `GOGS_WORK_DIR`： 已废弃，请使用 `GITEA_WORK_DIR` 替代
+* `GOGS_CUSTOM`： 已废弃，请使用 `GITEA_CUSTOM` 替代
 
 ## 操作系统配置
 
-  * `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分
-  * `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME`
-  * `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量
+* `USER`：Gitea 运行时使用的系统用户，它将作为一些 repository 的访问地址的一部分
+* `USERNAME`： 如果没有配置 `USER`， Gitea 将使用 `USERNAME`
+* `HOME`： 用户的 home 目录，在 Windows 中会使用 `USERPROFILE` 环境变量
 
 ### 仅限于 Windows 的配置
 
-  * `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH`
-  * `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘）
-  * `HOMEPATH`：在指定主驱动器下的 home 目录相对路径
+* `USERPROFILE`： 用户的主目录，如果未配置则会使用 `HOMEDRIVE` + `HOMEPATH`
+* `HOMEDRIVE`: 用于访问 home 目录的主驱动器路径（C盘）
+* `HOMEPATH`：在指定主驱动器下的 home 目录相对路径
 
 ## Miscellaneous
 
-  * `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。
+* `SKIP_MINWINSVC`：如果设置为 1，在 Windows 上不会以 service 的形式运行。

docs/content/doc/advanced/environment-variables.zh-cn.md

@@ -127,6 +127,7 @@ ALLOW_ATTR = class
 ### Example: Office DOCX
 
 Display Office DOCX files with [`pandoc`](https://pandoc.org/):
+
 ```ini
 [markup.docx]
 ENABLED = true
@@ -138,13 +139,15 @@ ALLOW_DATA_URI_IMAGES = true
 ```
 
 The template file has the following content:
+
 ```
 $body$
 ```
 
 ### Example: Jupyter Notebook
 
 Display Jupyter Notebook files with [`nbconvert`](https://github.com/jupyter/nbconvert):
+
 ```ini
 [markup.jupyter]
 ENABLED = true
@@ -156,9 +159,11 @@ ALLOW_DATA_URI_IMAGES = true
 ```
 
 ## Customizing CSS
-The external renderer is specified in the .ini in the format `[markup.XXXXX]` and the HTML supplied by your external renderer will be wrapped in a `<div>` with classes `markup` and `XXXXX`. The `markup` class provides out of the box styling (as does `markdown` if `XXXXX` is `markdown`). Otherwise you can use these classes to specifically target the contents of your rendered HTML. 
+
+The external renderer is specified in the .ini in the format `[markup.XXXXX]` and the HTML supplied by your external renderer will be wrapped in a `<div>` with classes `markup` and `XXXXX`. The `markup` class provides out of the box styling (as does `markdown` if `XXXXX` is `markdown`). Otherwise you can use these classes to specifically target the contents of your rendered HTML.
 
 And so you could write some CSS:
+
 ```css
 .markup.XXXXX html {
   font-size: 100%;
@@ -184,6 +189,7 @@ And so you could write some CSS:
 ```
 
 Add your stylesheet to your custom directory e.g `custom/public/css/my-style-XXXXX.css` and import it using a custom header file `custom/templates/custom/header.tmpl`:
+
 ```html
 <link type="text/css" href="{{AppSubUrl}}/assets/css/my-style-XXXXX.css" />
 ```

docs/content/doc/advanced/external-renderers.en-us.md

@@ -251,7 +251,7 @@ This template produces something along these lines:
 >
 > \_********************************\_********************************
 >
-> Mike, I think we should tone down the blues a little.  
+> Mike, I think we should tone down the blues a little.
 > \_********************************\_********************************
 >
 > [View it on Gitea](#).