目錄
Markdown 語法格式

Markdown 語法格式¶

以下是 Markdown 語法格式介紹，有關於 Textile 語法格式請參閱 Textile。
目前 HTML 標籤預設是不允許使用的，其他 Markdown 的相關限制請參閱 #16373 和 #21443

超連結¶

Redmine 內部連結¶

Redmine 允許超連結至任何地方的資源（Wiki、議題、文件...）

Wiki 超連結：

[[Redmine guide]] 顯示名為「Redmine guide」的超連結並指向一個新頁面：Redmine guide
[[Redmine guide#開發者手冊]] 直接前往「Redmine guide」頁面中的錨點「開發者手冊」：Redmine guide
[[Redmine guide|rename Page]] 前往「Redmine guide」頁面，但超連結的名稱更改為另外一個名稱：rename Page
[[Redmine guide#開發者手冊|rename Page]] 同上效果，同時指定錨點位置：rename Page

你也可以連結至其他專案的 Wiki 頁面：

[[Project_name:some page]] 前往專案名稱「Project_name」中的「Some page」頁面
[[Project_name:]] 前往專案名稱「Project_name」的 Wiki 主頁面

如果 Wiki 超連結顯示紅色，代表該頁面還不存在，比如：Nonexistent page

超連結至其他資源：

議題：
- #124（議題連結：顯示#124，如果問題已關閉，則連結會被刪除）
- #124-6 或 #124#note-6（連結到議題註解：顯示#124-6 或 #124#note-6）
文件：
- document#17（連結至 ID 為 17 的文件）
- document:Greetings（連結到標題為「Greetings」的文件）
- document:"Some document"（文件標題包含空格時可使用雙引號）
- sandbox:document:"Some document"（連結至專案識別碼「sandbox」中標題為「Some document」的文件）
版本：
- version#3（連結到 ID 為 3 的版本）
- version:1.0.0（連結到名為「1.0.0」的版本）
- version:"1.0 beta 2"（版本名稱包含空格時可使用雙引號）
- project_name:version:1.0.0（連結到項目識別碼「project_name」中的版本「1.0.0」）
附件：
- attachment:file.zip（連結到目前物件名為file.zip的附件）
- attachment:"file name.zip"（檔案名稱包含非單字字元時可以使用雙引號）
- For now, attachments of the current object can be referenced only (if you're on an issue, it's possible to reference attachments of this issue only)
修訂集合：
- r758（超連結至一個修訂集合，顯示r758）
- commit:c6f4d0fd (link to a changeset with a non-numeric hash)
- svn1|r758 (link to a changeset of a specific repository, for projects with multiple repositories)
- commit:hg|c6f4d0fd (link to a changeset with a non-numeric hash of a specific repository)
- sandbox:r758 (link to a changeset of another project)
- sandbox:commit:c6f4d0fd (link to a changeset with a non-numeric hash of another project identifier)
代碼庫 Repository 檔案：
- source:some/file (link to the file located at /some/file in the project's repository)
- source:"some file" (link to the file with non word characters in the path)
- source:some/file@52 (link to the file's revision 52)
- source:some/file@master (link to the file in branch master)
- source:some/file#L120 (link to line 120 of the file)
- source:some/file@52#L120 (link to line 120 of the file's revision 52)
- source:repo_identifier|some/file (link to a file of a specific repository, for projects with multiple repositories)
- sandbox:source:some/file (link to the file in the project identifier "sandbox")
- sandbox:source:repo_identifier|some/file (link to the file, with non word characters in the path, of a specific repository in the project identifier "sandbox")
- export:some/file (force the download of the file)
論壇:
- forum#2 (連結到 ID 為 2 的論壇版面)
- forum:Discussion (連結到名為「Discussion」的論壇版面)
- forum:"Help and more" (論壇版面名稱包含空格時可使用雙引號)
論壇留言：
- message#1218 (link to message with id 1218)
新聞：
- news#1（連結至 ID 為 1 的新聞項目）
- news:Greetings（連結到名為「Greetings」的新聞項目）
- news:"eCookbook 首次發布！" （新聞項目名稱包含空格時可使用雙引號）
專案：
- project#1（連結到 id 為 3 的專案）
- project:goodproject（連結到名為「goodproject」的專案）
- project:"Good project"（專案名稱包含空格時可使用雙引號）
用戶：
- user#1（連結到 ID 為 1 的使用者）
- user:jsmith（連結到登入名稱為「jsmith」的使用者）
- @jsmith（連結到登入名稱為「jsmith」的使用者）

跳脫：

您可以透過在 Redmine 連結前面加上驚嘆號來避免該文字被作用

外部連結¶

URLs (http, https, ftp and ftps) 會自動轉換為可點擊的超連結：

https://www.redmine.org -- 外部連結至 redmine.org：https://www.redmine.org

URLs 也可以以文字或圖片形式顯示超連結：

[Redmine web site](http://www.redmine.org) -- 以不同文字顯示的外部超連結: Redmine web site
[![Redmine web site](Redmine_logo.png)](http://www.redmine.org) -- External image with a title that links to an URL:

Email 地址¶

Email 地址可以自動被轉換成可點選的連結

someone@foo.bar -- 直接連結的 Email 地址：someone@foo.bar
[Email someone](mailto:someone@foo.bar) -- 以不同文字連結到該 Email 地址：Email someone

可以加入更複雜的內容到 Email 連結之中，比如一個預設的信件主題、內容和抄送名單可以被定義進來，注意！空格處都需要被替換為「%20」

[Email webmaster and admin](mailto:webmaster@foo.bar?cc=admin@foo.bar) -- Email 給 webmaster、並副本抄送給 admin：Email webmaster and admin
[Email someone for help](mailto:someone@foo.bar?subject=Website%20Help) -- Email 連結自帶主題名為「Website Help」:Email someone for help
[Email someone for help](mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20) -- Email 連結自帶主題和預設內容「My Problem is」:Email someone for help

文字格式¶

對於標題、粗體、表格、列表等內容，Redmine 支援 Markdown 語法，參見 http://daringfireball.net/projects/markdown/syntax 、http://agea.github.io/tutorial.md/ 、http://stackoverflow.com/editing-help 以取得更多相關功能與資訊，以下包含一些範例，有關文檔轉換請參閱 Pandoc，而 Redcarpet formatter 正在被使用

字體形式¶

* **bold** __bold__
* *italic* _italic_
* ***bold italic*** ___bold italic___
* <ins>underline</ins>
* <del>strike through</del>
* Plain <sup>superscript</sup>
* Plain <sub>subscript</sub>
* `inline monospace`
* normal **bold** _italic_ normal;E=mc<sup>2</sup>
* normal<strong>bold</strong><em>italic</em>normal;E=mc<sup>2</sup>
* Escaping: \*\*bold\*\* \_italic\_ \`inlinemono\`

顯示如下：

bold bold
italic italic
bold italic bold italic
underline
~~strike through~~
Plain ^superscript
Plain _subscript
inline monospace
normal bold italic normal;E=mc²
normalbolditalicnormal;E=mc²
Escaping: **bold** _italic_ `inlinemono`

注意！若要允許 Redmine 使用 HTML 標籤（<strong>、<em>、<ins>、<del>、<sup>、<sub>），相關信息請參閱 #15520-16 和 #15520-17，更明確的修正 Patch 方式請參閱這篇文章

內嵌圖片¶

![](image_url) 透過圖片網址顯示圖片
![alt text](image_url "optional title") 顯示圖片並包含 alt/標題屬性
[![](image_url)](URL) 顯示一張帶有超連結的圖片

如果你的 Wiki 頁面包含一個圖片附件，則可以直接使用檔案名稱連結顯示該圖片：![](attached_image.png)

截至撰寫本文時，Markdown 還未有用於指定圖像尺寸的語法，如果這對您很重要，您可以使用常規 HTML 標記。

<img style="float:right" src="URL"/>
<img style="width:100%" src="attached_image.png"/>

注意！若要允許 Redmine 使用 HTML 標籤（<img>），相關信息請參閱 #15520-16 和 #15520-17，更明確的修正 Patch 方式請參閱這篇文章

標題¶

# 主標題

## 中標題

### 小標題

主標題
=======

中標題
----------

水平分隔線¶

---

顯示如下：

區塊引用¶

您可以在每行的開頭使用 > 並將它們堆疊起來以形成嵌套引用：

>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
>> To go live, all you need to add is a database and a web server.

> Great!

Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
To go live, all you need to add is a database and a web server.

Great!

沒有順序排列的清單列表¶

使用星號 (*)、加號 (+) 或連字號 (-) 作為清單標記

* Item 1
* Item 2
  * Item 21 (兩個空格縮排)
  * Item 22
* Item 3

顯示如下：

Item 1
Item 2
- Item 21 (兩個空格縮排)
- Item 22
Item 3

有順序排列的清單列表¶

有序列表使用數字後面跟著句點接著一個空格

1. Item 1
2. Item 2
3. Item 3
  1. Item 3.1 (兩個空格縮排)
  1. Item 3.2

顯示如下：

Item 1
Item 2
Item 3
1. Item 3.1 (兩個空格縮排)
2. Item 3.2

表格¶

|UserID (向右對齊)|Name (向左對齊)|Group (置中對齊)|
|-------------------:|:----------------|:------------------:|
|2                   |John Smith       |                    |
|3                   |Dave Lopper      |A Team              |
|4                   |Robert Hill      |B Team              |

顯示如下：

UserID (向右對齊)	Name (向左對齊)	Group (置中對齊)
2	John Smith
3	Dave Lopper	A Team
4	Robert Hill	B Team

目錄¶

{{toc}} => 靠左對齊 toc
{{>toc}} => 靠右對齊 toc

請記住，目錄標籤的上方和下方需要有一個空白行，並且前後沒有其他文字。

範例：

### headLineOne

### something

{{toc}}

### something more

註腳¶

註腳是成雙成對的，工作方式類似於參考連結：它由文字旁邊的標記組成，例如

This is a sentence. [^1]

以及文檔中任意位置的單獨一行的註腳定義，例如

[^1]: This is a footnote.

巨集¶

Redmine 包含一個巨集系統，可讓您新增自訂函數以在格式化文字中插入動態內容。您可以透過 RedmineMacros了解如何在編寫自己的巨集。Redmine 還包含一些內建巨集：

hello_world

{{hello_world}} -- 範例 macro.

macro_list

{{macro_list}} -- 顯示所有可用的巨集列表，包括說明（如果有的話）

child_pages

顯示子頁面清單。如果沒有參數，它會顯示目前 wiki 頁面的子頁面。範例：

{{child_pages}} -- 只能在 wiki 頁面中使用
{{child_pages(depth=2)}} -- 僅顯示 2 層嵌套
{{child_pages(Foo)}} -- 列出頁面 Foo 的所有子頁面
{{child_pages(Foo, Parent=1)}} -- 與上面相同，帶有指向頁面 Foo 的鏈接

include

包括一個 Wiki 頁面。範例：

{{include(Foo)}}
{{include(projectname:Foo)}} -- 包含特定專案的 wiki 頁面

collapse

插入折疊的文字區塊，範例：

{{collapse
這是預設折疊的文字區塊，可以透過點擊連結來展開
}}

{{collapse（查看詳情...）
帶有自訂連結的文字
}}

thumbnail

顯示附加圖像的可點選縮圖，預設大小為 200 像素，範例：

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}} -- 自訂標題和尺寸大小

issue

顯示包含附加資訊的問題連結，範例：

{{issue(123)}}                              -- Issue #123: Enhance macro capabilities
{{issue(123, project=true)}}                -- Andromeda - Issue #123: Enhance macro capabilities
{{issue(123, tracker=false)}}               -- #123: Enhance macro capabilities
{{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123

高亮程式碼¶

預設程式碼高亮顯示依賴於 Rouge，這是一個用純 Ruby 編寫的語法高亮顯示庫。它支援許多常用語言，例如c、cpp (c++)、csharp (c#、cs)、css、diff (patch、udiff)、go (golang)、groovy、html、java、javascript (js)、kotlin、Objective_c ( objc)、perl (pl)、php、python (py)、r、ruby (rb)、sass、scala、shell (bash、zsh、ksh、sh)、sql、swift、xml和yaml (yml) 語言，其中括號內的名稱是別名。請參閱 RedmineCodeHighlightingLanguages 以取得支援語言的完整清單。

您可以使用以下語法來高亮顯示 wiki 頁面中的程式碼：

``` ruby
Place your code here...
```

範例：

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end

Markdown 其他語系的翻譯版本¶

請注意，以下翻譯版本可能不是最新的，如果需要、請參閱原始英文文件。

檔案 (1)

回到頁首

專案

一般

配置概況

Redmine-TW

Wiki

Markdown 語法格式¶

超連結¶

Redmine 內部連結¶

外部連結¶

Email 地址¶

文字格式¶

字體形式¶

內嵌圖片¶

標題¶

水平分隔線¶

區塊引用¶

沒有順序排列的清單列表¶

有順序排列的清單列表¶

表格¶

目錄¶

註腳¶

巨集¶

高亮程式碼¶

Markdown 其他語系的翻譯版本¶