Markdown¶

• Markdown
  • Markdownの記述例
  • 上記記述のRedmineでの表示
• 見出し1
  • 見出し2
    • 見出し3
• Redmine独自の特殊なWikiフォーマット
  • 目次
  • マクロ
    • hello_world
    • include
    • child_pages
    • collapse
    • thumbnail
    • macro_list
• その他の記法(Textile記法含む)
• その他(tool)

Markdownの記述例¶

**太字**
*斜体*
~~取り消し線~~
`inline code`

# 見出し1
## 見出し2
### 見出し3

* リスト1
* リスト2
* リスト3

1. リスト1
2. リスト2
3. リスト3

\`\`\`java
public class HelloWorld {
  public static void main (String[] args) {
    System.out.println("hello, world");
  }
}
\`\`\`

| テーブルヘッダ1 | テーブルヘッダ2 |
|-----------------|-----------------|
| セル1           | セル2           |


[リンク](http://redmine.jp/)

![画像表示](test.png)

attachment:test.txt

---

Redmineのシンタックスハイライトの対応形式

形式	class属性に指定する値
C	c, h
C++	cpp, cplusplus
Clojure	clj
CSS	css
Delphi	delphi, pascal
diff	diff
ERB	erb, rhtml, eruby
Groovy	groovy
HAML	haml
HTML	html, xhtml
Java	java
Javascript	java_script, ecma, ecmascript, ecma_script, javascript, js
JSON	json
PHP	php
plain	text plaintext, plain
Python	python
RHTML	rhtml
Ruby	ruby, irb
SQL	sql
XML	xml
YAML	yaml, yml

Bashも追加したので、このサイトは以下も有効

形式	class属性に指定する値
シェルスクリプト(Bash)	bash

上記記述のRedmineでの表示¶

目次

• Markdown
  • Markdownの記述例
  • 上記記述のRedmineでの表示
• 見出し1
  • 見出し2
    • 見出し3
• Redmine独自の特殊なWikiフォーマット
  • 目次
  • マクロ
    • hello_world
    • include
    • child_pages
    • collapse
    • thumbnail
    • macro_list
• その他の記法(Textile記法含む)
• その他(tool)

• Markdown
  • Markdownの記述例
  • 上記記述のRedmineでの表示
• 見出し1
  • 見出し2
    • 見出し3
• Redmine独自の特殊なWikiフォーマット
  • 目次
  • マクロ
    • hello_world
    • include
    • child_pages
    • collapse
    • thumbnail
    • macro_list
• その他の記法(Textile記法含む)
• その他(tool)

太字
斜体
取り消し線
inline code

見出し1¶

見出し2¶

見出し3¶

• リスト1
• リスト2
• リスト3

1. リスト1
2. リスト2
3. リスト3

public class HelloWorld {
  public static void main (String[] args) {
    System.out.println("hello, world");
  }
}

テーブルヘッダ1	テーブルヘッダ2
セル1	セル2

リンク

test.txt

Redmine独自の特殊なWikiフォーマット¶

目次¶

目次(左寄せ)
{{>toc}}

目次(右寄せ)
{{toc}}

実際の表示:

• Markdown
  • Markdownの記述例
  • 上記記述のRedmineでの表示
• 見出し1
  • 見出し2
    • 見出し3
• Redmine独自の特殊なWikiフォーマット
  • 目次
  • マクロ
    • hello_world
    • include
    • child_pages
    • collapse
    • thumbnail
    • macro_list
• その他の記法(Textile記法含む)
• その他(tool)

• Markdown
  • Markdownの記述例
  • 上記記述のRedmineでの表示
• 見出し1
  • 見出し2
    • 見出し3
• Redmine独自の特殊なWikiフォーマット
  • 目次
  • マクロ
    • hello_world
    • include
    • child_pages
    • collapse
    • thumbnail
    • macro_list
• その他の記法(Textile記法含む)
• その他(tool)

マクロ¶

Redmineには以下のビルトインマクロがあります:

hello_world¶

サンプルマクロ

{{hello_world}}

実際の使用例:

Hello world! Object: WikiContent, Called with no argument and no block of text.

include¶

wikiページの内容を挿入します。

{{include(Foo)}}

child_pages¶

子ページの一覧を表示します。引数の指定が無ければ現在のwikiページの子ページを表示します。

{{child_pages}}
{{child_pages(depth=2)}}

collapse¶

折り畳まれた状態のテキストを挿入します。以下は使用例です:

{{collapse(詳細を表示...)
この部分はデフォルトでは折り畳まれた状態で表示されます。
リンクをクリックすると展開されます。
}}

詳細を表示...詳細を表示...

thumbnail¶

添付ファイルのサムネイル画像を表示

{{thumbnail(test.png)}}

macro_list¶

利用可能なマクロの一覧および説明を表示します。

{{macro_list}}

実際にやってみると↓

hello_world

Sample macro.

macro_list

Displays a list of all available macros, including description if available.

child_pages

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

{{child_pages}} -- can be used from a wiki page only
{{child_pages(depth=2)}} -- display 2 levels nesting only

include

Include a wiki page. Example:

{{include(Foo)}}

or to include a page of a specific project wiki:

{{include(projectname:Foo)}}

collapse

Inserts of collapsed block of text. Example:

View details...View details...

This is a block of text that is collapsed by default.
It can be expanded by clicking a link.

thumbnail

Displays a clickable thumbnail of an attached image. Examples:

Error executing the thumbnail macro (Attachment image.png not found)

Error executing the thumbnail macro (Attachment image.png not found)

rawhtml

review

This is my macro link to code review

build

This is my macro link to hudson

その他の記法(Textile記法含む)¶

Redmineにおけるwiki記法
http://redmine.jp/tech_note/RedmineWikiFormatting/

Wiki formatting
http://redmine.jp/files/wiki_syntax_ja/wiki_syntax_detailed.html

Redmine text formatting cheat sheet
https://alphanodes.com/de/infografiken/redmine-wikisyntax-cheatsheet.pdf

Markdown記法まとめてみた
https://qiita.com/futaro0405/items/3b86020afbb2c45f13f2

その他(tool)¶

Microsoft Word を Markdown に変換するコマンド「docx2md」を作った
https://mattn.kaoriya.net/software/lang/go/20191010130133.htm