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

Diff for: .editorconfig

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

Diff for: .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

Diff for: 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

Diff for: 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)

Diff for: 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

Diff for: 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`.
 

Diff for: 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 的形式运行。

Diff for: 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" />
 ```

Diff for: 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](#).

Diff for: docs/content/doc/advanced/mail-templates-us.md

@@ -15,7 +15,7 @@ menu:
 
 # Protected tags
 
-Protected tags allow control over who has permission to create or update Git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once. 
+Protected tags allow control over who has permission to create or update Git tags. Each rule allows you to match either an individual tag name, or use an appropriate pattern to control multiple tags at once.
 
 **Table of Contents**
 

Diff for: docs/content/doc/advanced/protected-tags.en-us.md

@@ -37,7 +37,7 @@ For an existing remote repository, you can set up pull mirroring as follows:
 3. Enter a repository URL.
 4. If the repository needs authentication fill in your authentication information.
 5. Check the box **This repository will be a mirror**.
-5. Select **Migrate repository** to save the configuration.
+6. Select **Migrate repository** to save the configuration.
 
 The repository now gets mirrored periodically from the remote repository. You can force a sync by selecting **Synchronize Now** in the repository settings.
 

Diff for: docs/content/doc/advanced/repo-mirror.en-us.md

@@ -25,7 +25,6 @@ create a file called `robots.txt` in the [`custom` folder or `CustomPath`]({{< r
 
 Examples on how to configure the `robots.txt` can be found at [https://moz.com/learn/seo/robotstxt](https://moz.com/learn/seo/robotstxt).
 
-
 ```txt
 User-agent: *
 Disallow: /

Diff for: docs/content/doc/advanced/search-engines-indexation.en-us.md

@@ -14,23 +14,26 @@ menu:
 ---
 
 # 第三方工具列表
+
 **注意:** 这些工具并没有经过Gitea的检验，在这里列出它们只是为了便捷.
 
 *此列表并不是完整的列表，可以随时咨询如何添加!*
 
 ### 持续集成
-[BuildKite 连接器](https://github.com/techknowlogick/gitea-buildkite-connector)  
-[Jenkins 插件](https://github.com/jenkinsci/gitea-plugin)  
-[Gitea搭配Drone](https://docs.drone.io/installation/gitea)
 
+[BuildKite 连接器](https://github.com/techknowlogick/gitea-buildkite-connector)
+[Jenkins 插件](https://github.com/jenkinsci/gitea-plugin)
+[Gitea搭配Drone](https://docs.drone.io/installation/gitea)
 
 ### 迁移
-[Gitea安装脚本](https://git.coolaj86.com/coolaj86/gitea-installer.sh)  
-[GitHub迁移](https://gitea.com/gitea/migrator)
 
+[Gitea安装脚本](https://git.coolaj86.com/coolaj86/gitea-installer.sh)
+[GitHub迁移](https://gitea.com/gitea/migrator)
 
 ### 移动端
+
 [安卓客户端GitNex](https://gitlab.com/mmarif4u/gitnex)
 
-###  编辑器扩展
- - [Gitea的Visual Studio扩展](https://github.com/maikebing/Gitea.VisualStudio)    从   [Visual Studio 扩展市场](https://marketplace.visualstudio.com/items?itemName=MysticBoy.GiteaExtensionforVisualStudio) 下载
+### 编辑器扩展
+
+- [Gitea的Visual Studio扩展](https://github.com/maikebing/Gitea.VisualStudio)    从   [Visual Studio 扩展市场](https://marketplace.visualstudio.com/items?itemName=MysticBoy.GiteaExtensionforVisualStudio) 下载

Diff for: docs/content/doc/advanced/third-party-tools.zh-cn.md

@@ -48,7 +48,6 @@ A new token can be generated with a `POST` request to
 Note that `/users/:name/tokens` is a special endpoint and requires you
 to authenticate using `BasicAuth` and a password, as follows:
 
-
 ```sh
 $ curl -XPOST -H "Content-Type: application/json"  -k -d '{"name":"test"}' -u username:password https://gitea.your.host/api/v1/users/<username>/tokens
 {"id":1,"name":"test","sha1":"9fcb1158165773dd010fca5f0cf7174316c3e37d","token_last_eight":"16c3e37d"}

Diff for: docs/content/doc/developers/api-usage.en-us.md

@@ -21,8 +21,8 @@ menu:
 
 ## Background
 
-Gitea uses Golang as the backend programming language. It uses many third-party packages and also write some itself. 
-For example, Gitea uses [Chi](https://github.com/go-chi/chi) as basic web framework. [Xorm](https://xorm.io) is an ORM framework that is used to interact with the database. 
+Gitea uses Golang as the backend programming language. It uses many third-party packages and also write some itself.
+For example, Gitea uses [Chi](https://github.com/go-chi/chi) as basic web framework. [Xorm](https://xorm.io) is an ORM framework that is used to interact with the database.
 So it's very important to manage these packages. Please take the below guidelines before you start to write backend code.
 
 ## Package Design Guideline
@@ -43,9 +43,9 @@ To maintain understandable code and avoid circular dependencies it is important
   - `modules/git`: Package to interactive with `Git` command line or Gogit package.
 - `public`: Compiled frontend files (javascript, images, css, etc.)
 - `routers`: Handling of server requests. As it uses other Gitea packages to serve the request, other packages (models, modules or services) must not depend on routers.
-  - `routers/api` Contains routers for `/api/v1` aims to handle RESTful API requests. 
-  - `routers/install` Could only respond when system is in INSTALL mode (INSTALL_LOCK=false). 
-  - `routers/private` will only be invoked by internal sub commands, especially `serv` and `hooks`. 
+  - `routers/api` Contains routers for `/api/v1` aims to handle RESTful API requests.
+  - `routers/install` Could only respond when system is in INSTALL mode (INSTALL_LOCK=false).
+  - `routers/private` will only be invoked by internal sub commands, especially `serv` and `hooks`.
   - `routers/web` will handle HTTP requests from web browsers or Git SMART HTTP protocols.
 - `services`: Support functions for common routing operations or command executions. Uses `models` and `modules` to handle the requests.
 - `templates`: Golang templates for generating the html output.
@@ -61,7 +61,7 @@ From left to right, left packages could depend on right packages, but right pack
 **NOTICE**
 
 Why do we need database transactions outside of `models`? And how?
-Some actions should allow for rollback when database record insertion/update/deletion failed. 
+Some actions should allow for rollback when database record insertion/update/deletion failed.
 So services must be allowed to create a database transaction. Here is some example,
 
 ```go
@@ -84,7 +84,7 @@ func CreateXXXX() error {\
 }
 ```
 
-You should **not** use `db.GetEngine(ctx)` in `services` directly, but just write a function under `models/`. 
+You should **not** use `db.GetEngine(ctx)` in `services` directly, but just write a function under `models/`.
 If the function will be used in the transaction, just let `context.Context` as the function's first parameter.
 
 ```go

Diff for: docs/content/doc/developers/guidelines-backend.md

@@ -26,6 +26,7 @@ Gitea uses [Less CSS](https://lesscss.org), [Fomantic-UI](https://fomantic-ui.co
 The HTML pages are rendered by [Go HTML Template](https://pkg.go.dev/html/template).
 
 The source files can be found in the following directories:
+
 * **Less styles:** `web_src/less/`
 * **JavaScript files:** `web_src/js/`
 * **Vue components:** `web_src/js/components/`
@@ -41,36 +42,37 @@ We recommend [Google HTML/CSS Style Guide](https://google.github.io/styleguide/h
 2. HTML ids and classes should use kebab-case.
 3. HTML ids and classes used in JavaScript should be unique for the whole project, and should contain 2-3 feature related keywords. We recommend to use the `js-` prefix for classes that are only used in JavaScript.
 4. jQuery events across different features could use their own namespaces if there are potential conflicts.
-5. CSS styling for classes provided by frameworks should not be overwritten. Always use new class-names with 2-3 feature related keywords to overwrite framework styles.  
+5. CSS styling for classes provided by frameworks should not be overwritten. Always use new class-names with 2-3 feature related keywords to overwrite framework styles.
 6. The backend can pass complex data to the frontend by using `ctx.PageData["myModuleData"] = map[]{}`
 7. Simple pages and SEO-related pages use Go HTML Template render to generate static Fomantic-UI HTML output. Complex pages can use Vue2 (or Vue3 in future).
 
-
 ### Framework Usage
 
 Mixing different frameworks together is discouraged, it makes the code difficult to be maintained.
 A JavaScript module should follow one major framework and follow the framework's best practice.
 
 Recommended implementations:
+
 * Vue + Vanilla JS
 * Fomantic-UI (jQuery)
 * Vanilla JS
 
 Discouraged implementations:
+
 * Vue + Fomantic-UI (jQuery)
 * jQuery + Vanilla JS
 
 To make UI consistent, Vue components can use Fomantic-UI CSS classes.
-Although mixing different frameworks is discouraged, 
-it should also work if the mixing is necessary and the code is well-designed and maintainable. 
+Although mixing different frameworks is discouraged,
+it should also work if the mixing is necessary and the code is well-designed and maintainable.
 
 ### `async` Functions
 
-Only mark a function as `async` if and only if there are `await` calls 
+Only mark a function as `async` if and only if there are `await` calls
 or `Promise` returns inside the function.
 
 It's not recommended to use `async` event listeners, which may lead to problems.
-The reason is that the code after await is executed outside the event dispatch. 
+The reason is that the code after await is executed outside the event dispatch.
 Reference: https://github.com/github/eslint-plugin-github/blob/main/docs/rules/async-preventdefault.md
 
 If we want to call an `async` function in a non-async context,
@@ -88,10 +90,9 @@ However, there are still some special cases, so the current guideline is:
   * `$.data()` can be used to bind some non-string data to elements in rare cases, but it is highly discouraged.
 
 * For new code:
-  * `node.dataset` should not be used, use `node.getAttribute` instead. 
+  * `node.dataset` should not be used, use `node.getAttribute` instead.
   * never bind any user data to a DOM node, use a suitable design pattern to describe the relation between node and data.
 
-
 ### Legacy Code
 
 A lot of legacy code already existed before this document's written. It's recommended to refactor legacy code to follow the guidelines.