YouTrack サーバー 2024.3 ヘルプ

Markdown の構文

YouTrack では、Markdown マークアップ構文を使用してテキストをフォーマットできます。課題の説明、補足テキストフィールド、コメント、作業項目の説明のテキストをフォーマットできます。このタイプのマークアップは、リッチテキストエディターのビジュアルフォーマットツールの代わりに提供されます。テキストのフォーマットに使用できるオプションの詳細については、リッチテキストエディターを参照してください。

YouTrack の Markdown 実装は、拡張機能付きの CommonMark の仕様(英語)に従います。これらの拡張機能は、チェックリスト、取り消し線付きのテキスト、表、ユーザーのメンション、課題のリンクなど、正式な仕様に含まれていないフォーマットオプションをサポートしています。

フォーマットオプションの完全なリストを表示するには、Markdown リンクをクリックして構文リストを開き、 ヘルプアイコンをクリックします。これにより、ブラウザーで YouTrack マークアップのリファレンスページが開きます。

Youtrack markup reference markdown

YouTrack マークアップのリファレンスページにサンドボックスがあります。サンドボックスを使用してフォーマットされた出力をプレビューします。テキストが好みに合わせてフォーマットされたら、サンドボックスの内容をコピーして課題の説明またはコメントに貼り付けます。

使用可能

YouTrack は、課題フィールドに加えて、プロジェクトの説明マークダウンノートウィジェットユーザー契約システム全体のバナーログインページのカスタムメッセージで Markdown をサポートします。ここで説明する拡張機能の多くは、これらのフィールドでは使用できません。例: Google アプリからの埋め込みコンテンツ、埋め込みビデオ、YouTube ビデオ、課題のリンク、記事のリンク、ユーザーのメンションをサポートする拡張機能は、課題と記事でのみサポートされます。HTML タグを解析する機能は、号と記事のみに限定されます。

これらのフィールドに入力したコンテンツが正しくフォーマットされていることを確認するには、入力フィールドの左側にあるプレビューペインを使用してください。

Markdown availability

文字書式設定

次の Markdown 構文を使用して、さまざまなインラインテキストに文字書式を適用できます。

スタイル

構文

ストロング

2 つのアスタリスク(**)または 2 つの下線文字(__)でテキストを囲みます。

強調

単一のアスタリスク(*)または単一の下線文字(_)でテキストを囲みます。

取り消し線

テキストを 2 つのチルダで囲む(~~

コード

インラインコードスパンをフォーマットするには、1 つ以上の逆引用符でテキストを囲みます(`)。

組み合わせ

2 つのアスタリスクの中に 1 つの下線文字または 2 つのチルダを使用してテキストを囲みます。強い強調を適用するために 3 つのアスタリスクでテキストを囲みます。

You should read this, it's **very important**. You _might_ want to read this. ~~Never mind~~ - it wasn't _that_ important. Let's try a few `combinations`: **This text is strong, ~~this text is strong with strikethrough~~, and _this text is formatted with strong emphasis_** ***This text is formatted with strong emphasis too.***

見出し

見出しは、テキストをさまざまなセクションに整理できます。見出しは、太字のフォントサイズを大きくすることで、テキストの残りの部分と区別されます。

見出しスタイルを適用するには、1 〜 6 つの番号記号(#)で行を始めます。番号記号の後にスペース文字を続けて、見出しテキストを入力します。# サインの数は、見出しレベルを決定します。

YouTrack は見出しレベル 1 と 2 の代替構文もサポートします。

  • 見出しレベル 1 の場合、次の行に 1 つ以上の = 文字を入力します。

  • 見出しレベル 2 の場合は、次の行に 1 つ以上の - 文字を入力します。

# Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 ###### Heading 6 Heading 1 - Alternative Syntax ======== Heading 2 - Alternative Syntax --------

段落と改行

テキストの連続行は同じ段落に属します。次のガイドラインに従って、コンテンツを段落に分割して改行を入力してください。

  • 新しい段落を始めるには、テキスト行の間に空白行を入れます。

  • 段落内で新しい行を開始するには、テキスト行の末尾に 2 つ以上の末尾スペースを入力します。より見やすい方法として、単一のバックスラッシュ(\)を入力してください。

Even though this text is written on two separate lines, it is parsed as a single paragraph. This paragraph is separated from the previous paragraph by a blank line. This text is parsed as a single paragraph. The two trailing spaces at the end of the previous line start a new line.\ The backslash character also starts a new line.

テーマ別休憩

テーマ別の区切りでコンテンツにセクションを作成します。テーマ別の休憩を追加するには、次のいずれかの方法を使用します。

  • 3 つ以上のアンダースコア (___)

  • 3 つ以上のマイナス記号 (---)

  • 3 つ以上のアスタリスク (***)

サブジェクトの区切りによって段落が中断されたり、空白文字が含まれたりする可能性があることに注意してください。インデントには 3 つを超えるスペースを使用することはできず、同じ非空白文字を使用する必要があります。

The underscores on the next line create a thematic break below this paragraph. ___ The minus signs below must be separated from this paragraph by a blank line. If not, they are parsed as a level 2 heading. ---- Three or more asterisks also create a thematic break. ****

ブロック引用符

別の情報源からの引用に特別な注意を払うには、ブロック引用符を使用します。引用符付きブロック内のインラインテキストに文字書式を適用できます。

テキストを引用ブロックとして設定するには、1 行以上の > 文字で行を始めます。これらの文字の後にスペースを入れて、引用符で囲まれたテキストを入力してください。> 符号の数は、引用ブロック内のネストレベルを決定します。

引用符が複数の段落にまたがる場合は、各空白行を > 文字で始める必要があります。これにより、引用ブロック全体が確実にグループ化されます。

> Use block quotes to emulate reply text. > This line is part of the same quote. This line is not formatted and does not belong to the quote block. > This block spans multiple paragraphs. > > The second paragraph is grouped with the previous paragraph in the same quote block. > Character formatting is _also_ supported inside the **quote block**. > Quote blocks can also be nested. >> When you start a new line with additional > characters, >>> it simulates a threaded conversation.

インデントコードブロック

テキストのブロックを等幅フォントでフォーマットして、コードとして識別して読みやすくすることができます。

Markdown でコードブロックをフォーマットするには、ブロックのすべての行を少なくとも 4 つのスペースでインデントします。インデントされたコードブロックは段落を中断できないため、段落とそれに続くインデントされたコードブロックの間に少なくとも 1 行の空行を挿入する必要があります。入力は次のように処理されます。

  • コードブロックの各行から 1 レベルのインデント(4 つのスペース)が削除されます。

  • コードブロックの内容はリテラルテキストであり、Markdown として解析されません。

  • 先頭スペースが 4 つ未満の空白でない行はコードブロックを終了し、新しい段落を開始します。

Start an indented code block following a paragraph with a blank line and at least four spaces of indentation: This is a code block. Blank lines between indented lines do not end the code block. Here is some HTML: <div class="footer"> © 2009—2017 JetBrains · All rights reserved </div> This line of text is not indented. It ends the code block and starts a new paragraph.

囲まれたコードブロック

インデントされたコードブロックとは異なり、フェンスで囲まれたコードブロックには、構文のハイライトに使用する言語を指定できる情報文字列があります。言語固有のハイライトにより、コードが読みやすくなります。

構文のハイライトは、さまざまな言語でサポートされています。YouTrack は、C、C++、C#、Java、JavaScript、Perl、Python、Ruby、SH のコードを自動的に検出してハイライトします。他の言語のコードをハイライトするには、情報文字列(開始コードフェンスのある行)で言語を設定します。次の言語がサポートされています: apollo(AGC/AEA Assembly Language)、basic、clj(Clojure)、css、dart、erlang、hs(Haskell)、kt(Kotlin)、latex(LaTeX)、lisp、llvm、lua、matlab、ml、mumps、n(Nemerle)、pascal、proto、scala、sql、tcl、tex、vb、vhdl、wiki、xq、yaml。

情報文字列で言語を設定すると、コードの上の行に言語タグが表示されます。

Fenced code block set as JavaScript.

YouTrack は、GitHub の Markdown 実装によって解釈される言語エイリアスのセットを認識します。これには、次の言語エイリアスが含まれます。

言語エイリアス

言語名

YouTrack による構文ハイライトの適用

fsharp

F#

fs

kts

Kotlin スクリプト

kt

オクターブ

マトラブ

マトラブ

ラテックス

ラテックス

テックス

vb.net または vbnet

Visual Basic .NET

vb

yml

YAML

ヤムル

テキストのブロックを構文のハイライト付きのコードのブロックとして設定するには、次のガイドラインに従います。

  • 複数行にわたるコードで囲まれたコードブロックを作成するには、テキストを 3 つ以上の逆引用符(```)またはチルダ(~~~)の内側に設定します。

  • 同じ文字でブロックを開閉します。

  • コードフェンスの開閉には同じ文字数を使用してください。

  • フェンスで囲まれたコードブロックを開くために使用する文字のセットと同じ行の直後に、構文のハイライトに使用する言語または言語エイリアスを指定します。

Set multiple lines of code in fenced code blocks. ``` action: (ctx) => { workflow.check(!ctx.issue.isChanged('votes'), workflow.i18n('Voting for a resolved issue is not allowed.')); }, ``` The following code block uses syntax highlighting for Haskell: ```hs -- Point-free style fib :: Integer -> Integer fib = (fibs !!) where fibs = 0 : scanl (+) 1 fibs -- Explicit fib :: Integer -> Integer fib n = fibs !! n where fibs = 0 : scanl (+) 1 fibs ```

スタックトレース

囲い込まれたコードブロックはスタックトレースとしてフォーマットできます。コードをスタックトレースとしてフォーマットするには:

  1. ちょうど 3 つの逆引用符(```)またはチルダ(~~~)で囲われたコードブロックを開閉します。コードブロックを開くのに使用した同じ文字でコードブロックを閉じます。

  2. 言語を設定するには、コードフェンスの最初の行に stacktrace と入力します。

  3. スタックトレースを fenced コードブロックに貼り付けます。

スタックトレースがフォーマットされると、ソースコードへの参照やその他の課題がリンクとして設定されます。開発環境でこの機能が有効になっている場合は、これらのリンクをクリックして IDE でターゲット参照を開くことができます。詳しくは、IDE でスタックトレースを開くを参照してください。

The following code block is formatted as a stacktrace. This fenced code block uses tildes, and sets the language as "stacktrace". ~~~stacktrace java.lang.NullPointerException at my.stack.trace(Of.java:123) ~~~

HTML ブロック

HTML ブロックは、生の HTML マークアップとして扱われる行のグループです。ブロックは、YouTrack が有効な HTML タグを検出した場所から始まり、一致する終了タグが存在する行で終了します。開始タグと終了タグ間のコンテンツは、エスケープせずに HTML でレンダリングされます。

有効な HTML コンテンツが記述どおりに表示されない場合があります。

  • すべてのマークアップは、許可されたタグの事前定義リストと照合されます。攻撃者によって悪用される可能性のあるタグおよび属性内のコンテンツは除外されます。

  • HTML ブロックを開始するタグの前に 3 つを超えるスペース文字を含めることはできません。4 つ以上のスペースで始まるブロックは、インデントされたコードとしてフォーマットされます。

HTML マークアップでは、次の機能を使用して課題のコンテンツを強化できます。

フィーチャー

説明

折りたたみ可能なブロック

<details> タグを使用して、補足情報を非表示にします。クリック可能なコントロールを使用すると、読者はテキストのブロックを表示するように展開したり、非表示にすることができます。

カスタムテキストの色

<font> タグを使用して、指定した色でテキストを設定します。例: <font color="red">red text</font>

改行

<br> タグは、テーブルセル内であっても、新しい行を開始するすべての場所で使用します。

イージーモードのブロック引用

<blockquote> タグを使用して、空行を含むテキストブロックを引用テキストの単一ブロックとしてフォーマットします。つまり、これらのタグの間にテキストブロック全体を貼り付けることができ、コンテンツはブロック引用としてフォーマットされます。

Markdown のブロック引用符のネイティブ構文で同じ結果を得るには、空の各行に > 文字を追加する必要があります。

インラインテキストも HTML マークアップ用に解析されます。左山括弧括弧(<)と終了山括弧括弧(>>)の間に設定されたテキストは、許可タグの事前定義リストと照合されます。YouTrack が安全であると判断した場合、タグは HTML として解析されます。タグ内のコンテンツは、エスケープせずに HTML でレンダリングされます。

HTML としてレンダリングされる課題にコンテンツを貼り付けていて、テキストを記述どおりに表示したい場合は、マークアップをエスケープする必要があります。方法については、HTML のエスケープを参照してください。

For collapsible blocks, the text inside the summary is always visible. Users can click the summary to show or hide the details. <details> <summary> <font color="red">SPOILER ALERT</font> </summary> Soylent Green is made from human flesh </details> HTML is great for formatting tables. It's a bit more flexible than Markdown syntax. <table> <tr> <th>Contributor</th> <th>Contribution Type</th> </tr> <tr> <td>Cecilia</td> <td>Code<br>Reviewing Pull Requests<br>Answering Questions</td> </tr> <tr> <td>Jakob</td> <td>Maintenance<br>Hosting Infrastructure<br>Build Tools</td> </tr> <tr> <td>Sylvia</td> <td>Design<br>Documentation</td> </tr> <tr> <td>Rob</td> <td>Translation</td> </tr> </table> Block quotes are a lot easier to format with HTML as well. One set of tags is all you need! <blockquote>Your time is limited, so don't waste it living someone else's life. Don't be trapped by dogma – which is living with the results of other people's thinking. </blockquote> — Steve Jobs

リスト

リストを作成するには、次の構文を使用します。

  • 番号なしリストを作成するには、マイナス記号(-)、アスタリスク(*)、プラス記号(+)で行を始めます。

  • 番号付きリストを作成するには、番号の後にピリオド(1.)または右括弧(1))を付けて行を始めます。番号付きリストの開始番号は、その初期リスト項目の番号によって決まります。後続のリスト項目の数は無視されます。

  • 番号なしリストを番号なしリストまたは番号付きリストの中にネストするには、行を 2 つのスペースでインデントします。順序付きリストのネストはサポートされていません。

The following list **must** begin with the number 1: 1. Only lists that start with 1 are allowed to interrupt paragraphs. 1. Subsequent numbering is irrelevant. 0. You can start a new line with any number as long as you use the same delimiter character. 2) This item uses a different delimiter and starts a new ordered list, starting with the number 2. This list can start with any number: 4) The empty line means that the list does not interrupt a paragraph. 1) The ordered list continues to increment the numbering from the previous list item. 123456789) Use any number fewer than ten characters. This number is parsed as the third item in the ordered list. * Start unordered lists with -, *, or +. + You don't even have to use the same character for each list item. - Pro tip: * and + require the Shift key. - doesn't. Format faster with the minus sign. * Nest unordered list items with two spaces. * Unordered lists support multiple levels of nesting.

チェックリスト

チェックリストは CommonMark の仕様(英語)ではサポートされていません。この機能は拡張機能で実装されています。GitHub Flavored Markdown のタスクリストの項目 (拡張)(英語) と似ていますが、YouTrack での実装は若干異なります。

チェックリストを作成するには、次の構文を使用します。

  • 順不同リストと同じようにチェックリストを開始します。行の先頭にマイナス記号(-)、アスタリスク(*)、プラス記号(+)を入力します。これはリストアイテムマーカーとして解釈されます。

  • リスト項目マーカーの後に 1 つ以上のスペース、左括弧 ([), either a whitespace character or the lowercase letter x, and then a right bracket (]) が続きます。これはチェックリスト項目マーカーとして解釈されます。

    • 括弧の間の文字が空白文字の場合、チェックボックスはオフになっています。

    • 括弧の間の文字が小文字の x である場合、チェックボックスはチェックされています。

  • チェックリスト項目マーカーの後に任意のテキスト文字列を入力します。テキストはチェックボックスとインラインで表示されます。

TODO: * [x] This item is marked as complete. The checkbox is checked. - [ ] This item is incomplete. The checkbox is unchecked. + [ ] As with unordered lists, you can start the line with an asterisk, minus sign, or plus sign. - [ ] Nest checklist items with two spaces. - [ ] Checklists support multiple levels of nesting.

テーブル

テーブルは、コンテンツに構造を追加するための優れたツールです。テーブルを作成するには、次の構文を使用します。

  • 列を作成するには、縦棒(|)を使用します。外側のバーはオプションです。

  • ヘッダー行を 3 つ以上のマイナス記号(---)でテーブルの残りの部分から区切ります。

  • 列テキストを右寄せにするには、区切り行のマイナス記号の右側にコロン(:)を追加します。

  • テキストを列の中央に配置するには、マイナス記号の両側にコロン(:)を追加します。

  • 列のテキストを左揃えにするには、区切り行のマイナス記号の左側にコロン(:)を追加します。

生の Markdown では列が完全に並んでいる必要はないことに注意してください。テーブル内のテキストに文字書式を追加することもできます。

Kitchen Cleanup Rotation | Month | Assignee | Backup | | -------- | -------- | ------ | | January | Dave | Steve | | February | Gregg | Karen | | March | Diane | Jorge | Here's the same text with additional formatting and alternative syntax. + The text in the first column is right-justified. + The text in the second column is centered. + The text in the third column is left-justified. + The Markdown is stripped down to the minimum syntax that is required to render the table. Month | Assignee | Backup ---:|:---:|:--- **January** | Dave | _Steve_ **February** | Gregg | _Karen_ **March** | Diane | _Jorge_

Markdown を使ってリンクを挿入する方法はいくつかあります。

スタイル

フォーマット

インライン化

リンクテキストを括弧 [ ] とそれに続く括弧内の URL ( ) で囲みます。

ツールチップとインライン

インラインフォーマットを使用し、URL の後に引用符でツールチップを追加します。

リファレンス

URL を括弧 [ ] でラップされた、大文字と小文字を区別しない任意の参照に置き換えます。参照テキストと URL を入力フィールドの別の場所に追加します。参照を定義するには、括弧でラップされた同じタグ名、コロン、URL の順に入力します。これらの参照は、レンダリングされたマークダウンには表示されません。同じターゲットに複数のリンクがある場合は、参照スタイルのリンクを使用してください。

YouTrack は、自動リンクを含むように標準構文も拡張しました。

[inline link](https://www.jetbrains.com) [inline link with tooltip](https://www.jetbrains.com "JetBrains: Development Tools for Professionals and Teams") [reference link][1] [1]: https://www.jetbrains.com

自動リンクは、山括弧括弧(< >)内に設定される絶対 URI とメールアドレスです。これらはリンクとして解析され、URL またはメールアドレスがリンクラベルとして使用されます。異なり、リンクリンクテキストとツールチップを指定することができ、この構文は、単純にクリック可能なリンクに URL やメールアドレスを変換します。

YouTrack は URL の拡張構文をサポートしています。URL として解析された文字列は、山括弧括弧がなくてもクリック可能なリンクに変換されます。山括弧括弧内に設定されていないメールアドレスはテキストとして表示されます。

Both of these URLs are parsed as links: <https://youtrack.jetbrains.com/issues> https://youtrack.jetbrains.com/issues Email addresses are also converted into "mailto" links when set in angle brackets: <webmaster@jetbrains.com>

既存の issue ID と一致する一連の文字が自動的に解析され、対応する issue へのリンクに変換されます。

On the YouTrack server for JetBrains (youtrack.jetbrains.com), the following string is parsed as an issue ID and set as a link to the corresponding issue: JT-43793

既存の記事 ID と一致する文字のシーケンスは自動的に解析され、ナレッジベースの対応する記事へのリンクに変換されます。ユーザーがリンクの上にポインターを移動すると、カスタムツールチップに、タイトル、作成者、作成日など、記事に関する追加情報が表示されます。

Link to an article in the knowledge base with tooltip.
In the screenshot above, the reference in the string is parsed as an article ID and set as a link to the corresponding article: JT-A-79

ユーザーのメンション

ユーザーのメンションもリンクとして設定されます。@ を入力すると、YouTrack は、ユーザー名が次の入力に一致するユーザーを提案します。選択したユーザーを完成させるか、有効なユーザー名を入力すると、@mention がユーザーの氏名に置き換えられ、リンクとして設定されます。

イメージ

イメージの構文はリンクの構文と似ています。インラインイメージを挿入するには:

  • 感嘆符(!)で行を始めてください。

  • 代替テキストを括弧([ ])で囲みます。

  • イメージの URL とツールチップを括弧内に設定します(( ))。

イメージに参照スタイルを使用することもできます。イメージ参照を挿入するには:

  • 感嘆符(!)で行を始めてください。

  • 代替テキストを括弧([ ])で囲みます。

  • イメージ参照を括弧([ ])に設定してください。

  • 構文 [tag]: image URL "tooltip" を使用して、イメージ参照を別の場所に定義します。

Here's an image link to the JetBrains logo on Wikipedia: ![JetBrains logo](https://upload.wikimedia.org/wikipedia/commons/1/1a/JetBrains_Logo_2016.svg "JetBrains") This link to the JetBrains logo uses the reference style: ![JetBrains logo][logo] [logo]: https://upload.wikimedia.org/wikipedia/commons/1/1a/JetBrains_Logo_2016.svg "JetBrains" Markdown also supports images as links. Just wrap the entire image reference in brackets then add the target URL in parenthesis after the image reference. People use this syntax to insert a thumbnail image that links to a video on a video sharing platform. Here's a reference to the latest video promotion for YouTrack: [![YouTrack — Maintain Order In A World of Chaos](https://img.youtube.com/vi/rhAunB7UQFQ/sddefault.jpg)](https://www.youtube.com/watch?v=rhAunB7UQFQ)

イメージ属性

イメージのカスタム height および width 寸法を設定できます。これらの属性は、YouTube 動画、埋め込み動画、Google アプリの埋め込みコンテンツでも利用できます。

次のガイドラインを使用して、カスタム表示サイズを設定します。

  • 波括弧({ })でサイズ属性をラップし、コンテンツ参照の後に置きます。

  • height または width 属性のいずれかを指定して、元のアスペクト比を維持しながらイメージを均等にスケーリングします。両方の属性を使用して、目的のディメンションを明示的に設定します。

  • 属性の値を整数として指定し、絶対サイズをピクセル単位で設定します。例: width=250 は 250px として解析されます。

  • width 属性をパーセンテージで指定して、表示領域に対するサイズを決定します。例: width=25% は、元の縦横比を維持しながら、表示領域の 25% を占めるようにイメージのサイズを変更します。

    この機能は、width 属性でのみサポートされています。パーセンテージとしての height 属性への参照は無視されます。

Here's an inline reference to the Markdown logo on Wikipedia that has been rescaled to fit the visible display area: ![Markdown logo](https://upload.wikimedia.org/wikipedia/commons/thumb/4/48/Markdown-mark.svg/208px-Markdown-mark.svg.png "Markdown"){width=100%}

画像の添付ファイル

issue にすでに添付されているイメージへのインライン参照を挿入できます。イメージは、参照が配置されている説明、コメント、作業項目に表示されます。

イメージに使用されているのと同じ構文を使用して、イメージの URL を添付ファイルのファイル名に置き換えます。

  • 感嘆符(!)で行を始めてください。

  • 代替テキストを括弧([ ])で囲みます。

  • ファイル名とオプションのツールチップを括弧内に設定します(( ))。

The following markup inserts an image with the filename `image.png`. The words "image attachment" are used for both the alt text and the tooltip. ![image attachment](image.png "image attachment")

添付ファイル

イメージに加えて、課題に添付されているファイルへのリンクを追加できます。イメージファイルまたは PDF を参照するリンクは、ブラウザーでファイルを直接開きます。他のすべてのファイルタイプの場合、リンクにより、ユーザーはファイルのコピーをローカルマシンにダウンロードできます。

ファイルにリンクを追加するための構文は、URL にリンクを追加するための形式に似ています。

スタイル

フォーマット

インライン化

リンクテキストを括弧 [ ] で囲み、その後に括弧 ( ) で拡張子を付けたファイル名を続けます。

ツールチップとインライン

インライン書式を使用して、ファイル名の後に引用符でツールチップを追加します。

リファレンス

URL を、括弧 [ ] でラップされた、大文字と小文字を区別しない任意の参照に置き換えます。入力フィールドの別の場所に参照テキストとファイル名を追加します。参照を定義するには、括弧でラップされた同じタグ名、コロン、拡張子の付いたファイル名の順に入力します。これらの参照は、レンダリングされたマークダウンに表示されません。同じターゲットファイルへのリンクが複数ある場合は、参照スタイルのリンクを使用します。

Here’s an example that uses each of these three styles to add links to a file named `markdown-rocks.html`. [inline](markdown-rocks.html) [inline with tooltip](markdown-rocks.html "Markdown implementation in YouTrack is A-M-A-Z-I-N-G !!!") [reference][1] [1]: markdown-rocks.html

埋め込み動画

イメージの添付ファイルの構文を使用して、issue に添付されているビデオファイルを埋め込むことができます。ビデオプレーヤーは周囲のテキストとインラインで表示されます。埋め込みプレーヤーで直接ビデオを再生できます。

  • 感嘆符(!)で行を始めてください。

  • 代替テキストを括弧([ ])で囲みます。

  • ファイル名を括弧内に設定します(( ))。

この機能は、MPEG-4、Ogg、WebM 形式のファイルにのみ使用できます。

The following markup embeds a video with the filename `MP4-video.mp4`. ![embedded video](MP4-video.mp4)

Mermaid ダイアグラム

Mermaid ダイアグラムは、フローチャート、シーケンスダイアグラム、ガントチャート、その他のデータやプロセスの視覚的表現を生成するために使用されるダイアグラム表作成言語およびツールの一種です。シンプルなマークダウンのような構文を使用して Mermaid ダイアグラムを作成できるため、簡単に記述して理解できます。

Mermaid ダイアグラムのコードがすでにある場合は、リッチテキストエディターに直接貼り付けることができます。

既存の Mermaid ダイアグラムを Markdown モードのリッチテキストエディターにコピーするには:

  1. フォーマットツールバーの Markdown ボタンをクリックして、ビジュアル編集モードに切り替えます。

  2. フォーマットツールバーの コードブロックアイコンをクリックするか、``` と入力して、囲まれたコードブロックを開きます。

  3. コードブロックに使用するプログラミング言語を mermaid として指定します。言語属性は、フェンスで囲まれたコードブロックを開くバッククォートの直後の同じ行に指定します。

  4. Mermaid ダイアグラムのコードをリッチテキストエディターのコードブロック領域に貼り付け、必要に応じて ``` と入力して囲まれたコードブロックを閉じます。

    A Mermaid diagram in the rich text editor using Markdown mode.

リッチテキストエディターで直接 Mermaid ダイアグラムを作成するには、フェンスコードブロックを開始し、プログラミング言語として mermaid を指定します。フェンスブロック内にダイアグラムのコードを記述します。入力すると、ダイアグラムがプレビューペインに表示されます。

LaTeX 数学表記

LaTeX でフォーマットされた数式があり、それを課題や記事で表示する必要がある場合は、それをフェンスで囲まれたコードブロックに入れて、そこで latex 言語を指定できます。YouTrack は LaTeX マークアップを認識し、数式をレンダリングします。

YouTrack の実装は、alignequationgatherarraymatrix を含む、さまざまなタイプの数学表記と構造のほとんどの環境をサポートします。また、表示数学モードを示すために二重ドル記号 ($$) を使用する古い表記法もサポートしています。表示数学モードでは、方程式、数式、数式がページの中央の別の行に表示されます。

YouTrack クラシックで課題を編集すると、レンダリングされた数式がプレビューに表示されます。変更を保存すると、課題はレンダリングされた出力を表示します。

LaTeX formula in Markdown

YouTrack Lite で記事または課題を編集すると、ビジュアルモードでレンダリングされた数式のプレビューを表示できます。

YouTrack は、LaTeX 式を処理するために KaTeX(英語) ライブラリを使用します。サポートされているシンボルと関数の完全なリストについては、ライブラリリファレンス(英語)を参照してください。

バックスラッシュのエスケープ

書かれたとおりに表示したい Markdown として解析された文字がある場合は、円記号(\)を使用してその文字をエスケープすることができます。

  • マークアップされていない文字の前のバックスラッシュはバックスラッシュ文字として表示されます。

  • エスケープ文字は通常の文字として扱われます。Markdown 構文におけるそれらの通常の意味は無視されます。

  • バックスラッシュエスケープは、分離コードブロック、インラインコードスパン、自動リンクでは機能しません。

Here are a few examples of backslash escapes: \*not emphasis* \`not an inline code span` 1\. not an ordered list \* not an unordered list \# not a heading \This is not a backslash escape - the escaped character is not a markup character.

HTML のエスケープ

コードを課題に貼り付けており、HTML としてレンダリングしたくない場合は、次のいずれかの方法を使用してマークアップをエスケープします。

  • スペースを作る — 4 つ以上のスペースでインデントされたテキストの行は、Markdown ではインデントされたコードブロックとして自動的にフォーマットされます

  • 囲い込む — コードを 3 つ以上の逆引用符 (```) またはチルダ (~~~) で囲み、「コードフェンス」を形成します。フェンスで囲まれたコードブロックでは、言語 ( html など) を指定して構文のハイライトを有効にすることもできます。

  • 切り戻す — 書かれたとおりに表示したい文字があるときはいつでも、円記号(\)で文字をエスケープします。

関連ページ:

リッチテキストエディター

フォーマットにより、書き言葉の明瞭さと表現が向上します。YouTrack は、リッチテキストエディターでテキストをフォーマットするための 2 つのモード、ビジュアルと Markdown を提供します。YouTrack は、課題、記事の編集、コメントの投稿時に最後に使用したモードを記憶しています。あるモードを他のモードよりも優先する場合は、切り替える必要はありません。リッチテキストエディターは、課題の説明、フォーマットされたテキストフィールド、コメント、作業項目の説明、ナレッジベース内の記事とそのコメ...

プロジェクトを構成する

プロジェクトを作成すると、YouTrack はプロジェクト概要ページを開きます。このページは、プロジェクトリストからプロジェクトを選択したときにも表示されます。プロジェクト概要ページから、プロジェクト管理ページにすばやくアクセスできます。プロジェクトチーム:プロジェクトが作成されると、プロジェクトチームが自動的に作成されます。プロジェクトを作成したユーザーは自動的にチームに追加されます。プロジェクトチームに追加されたユーザーとグループには、プロジェクト内のコントリビューターロールが付与されます...

クイックノートウィジェット

クイックノートウィジェットは、ダッシュボードに表示したいメッセージを表示します。このウィジェットを使用すると、Markdown 構文を使用してテキストをフォーマットできます。この機能は、ダッシュボードを他のユーザーと共有している場合に特に便利です。このウィジェットは、チームにとって重要な更新を投稿するためのボードとして使用できます。ダッシュボードにクイックノートウィジェットを追加するには: メインナビゲーションメニューでダッシュボードをクリックします。ウィジェットのダッシュボードを選択します。ダッ...

ユーザー使用許諾契約

YouTrack のユーザー使用許諾契約ページで、YouTrack にログインするユーザーに提示されるユーザー契約を保存できます。これにより、一連の契約条件やプライバシーポリシーなどの情報通知の個々の受け入れを収集および追跡できます。この機能を使用して、EU 加盟国で事業を行う企業の一般データ保護規則(GDPR)要件で概説されている YouTrack に保存されている個人データを処理するポリシーをユーザーに通知します。利用規約テキストのフォーマット:YouTrack では、Markdown を...

システム全体のバナーを表示する

システム内のすべてのユーザーに表示する通知を含む情報バナーを YouTrack に追加できます。例: システムメンテナンスの予定されたダウンタイムについてユーザーに警告できます。有効にすると、YouTrack の各ページの上部にバナーが表示されます。バナーは、ゲストを含め、YouTrack インストールを使用するすべてのユーザーに表示されます。バナー自体は次のように動作します。バナーは静的です。ユーザーはそれを閉じることも閉じることもできません。この機能が有効になっているときに YouTrack...

認証モジュールの共通設定

共通設定ページには、YouTrack のすべての認証モジュールに適用される構成オプションが表示されます。このページにアクセスするには、管理メニューのアクセス管理セクションから Auth モジュールを選択し、ツールバーの共通設定リンクをクリックします。一般設定:一般タブには次の設定が表示されます。トークンのタイムアウトアクセストークンの最大有効期間を指定します。この値を小さくすると、アクセストークンを取得した悪意のあるユーザーがアプリケーションにアクセスできる時間を制限できます。デフォルトは 1...