Shotgun Markdown でテキスト フィールドをフォーマット化するにはどうすればいいですか?

注: Shotgun は制限付きでテキストから HTML への変換もサポートします。 詳細については、「テキストから HTML への変換を使用してテキスト フィールドをフォーマット化するにはどうすればいいですか?」を参照してください。

現在、Shotgun は次の場所での Markdown レンダリングをサポートしています。

  • ノートの本文、ノートの返信、ノートの電子メール通知
  • チケットの説明、チケットの返信、チケットの電子メール通知

背景色とフォント スタイルを使用したセルと行のフォーマット化の詳細については、「レコードおよびフィールドをフォーマット化する(手動かつルールを使用)」を参照してください。

Shotgun の Markdown の実装では、一般的な「Github Flavored Markdown (GFM)」仕様にスマートな表記引用といくつかのスタイルの短縮形のプロパティを追加して使用します。

インライン レベル スタイリング

斜体と太字

自然な Slack スタイルの短縮形を導入しているため、Shotgun は GFM と異なります。

Markdown 出力
_italics_ 斜体
*bold* 太字

ただし、通常の太字には Markdown 標準を使用します。

Markdown 出力
__bold__ 太字
**bold** 太字

取り消し線

Markdown 出力
This is ~~bad~~ good! This is bad good!

リンク

Shotgun は認識した URL を自動的にリンクしますが、リンク テキストを指定する場合は、次を使用します。

Markdown 出力
[Example Site](http://example.com) サイト例

画像

Markdown 出力
![Title/Alt Text](URL) cat.jpeg

コード

Markdown 出力
This is the `source` variable This is the source variable

ブロック レベル スタイリング

段落

First paragraph

Second paragraph
with manual line-breaks

Third paragraph

見出し

見出しの先頭は # とスペースで始まります。

# Title

## Subtitle

### 3rd level

#### 4th level

##### 5th level?!

###### All the way up to 6th level!!
注: = または - を任意の数だけ使用すると、最初の 2 つのレベルをフォーマット化することもできます。
Title
=

Subtitle
--------

リスト

リストは次のようにシンプルです。

- One
- Two
- Three

数字を使用すると順序付きのリスト、- を使用すると順序なしのリストになります。必要に応じてネスト化が可能です(4 つのスペースを使用)。

Markdown 出力
1. First item
2. Second item
    with manual line-breaks
    - Item 2.1
    - Item 2.2
3. Third item
    - Item 3.1
        - Item 3.1.1
  1. First item
  2. Second item with manual line-breaks
    • Item 2.1
    • Item 2.2
  3. Third item
    • Item 3.1
    • Item 3.1.1

タスク項目

クイック タスク リストを作成することもできます。

Markdown 出力
- [x] I've completed this
- [x] ~~I've _really_ completed this!~~
- [ ] Still need to do this
    Remember to also check:
    - [ ] Bits
    - [X] Bobs
- [ ] and this
チェックボックス

Blockquote

Markdown 出力
A paragraph

> A blockquote with 
manual line-breaks > > A paragraph belonging to the blockquote
A paragraph
A blockquote with
manual line-breaks
Another paragraph

テーブル

テーブルの作成では、少なくともヘッダ行を - で分割して、セルを | で分割します。

Markdown 出力
| Keys | Values |
| ---- | ------ |
| id   | 1234   |
| code | Yoyo   |
Keys Values
id 1234
code Yoyo
注: - は任意の数で十分で、テーブルの境界を | で設定する必要はありません。 次の例は、見た目は良くないですが作成が簡単で、構文的には同じです。
Keys|Values
-|-
id|1234  
code|Yoyo  

セルの位置合わせ

次のように位置を指定することができます。

Markdown 出力
ID   | active? | description
---: | :-----: | :----------
1234 | Y       | Left-aligned
56   | N       | Text
ID active? description
1234 Y Left-aligned
56 N Text
注: - は任意の数で十分です。 次の例は、見た目は良くないですが作成が簡単で、構文的には同じです。
ID | active? | description
-: | :-: | :-
1234 | Y | Left-aligned
56 | N | Text

コード ブロック

コード ブロックは、新しい行に入力した 3 つのバッククォートを使用して区切ります。

```
['one', 2, THREE].forEach(function(i) {
    console.log("Index '%d'", i);
});
```

コード ブロックは言語も定義でき、構文を強調表示します。

Markdown 出力
```javascript
['one', 2, THREE].forEach(function(i) {
    console.log("Index '%s'", i);
});
```
['one', 2, THREE].forEach(function(i) {
    console.log("Index '%s'", i);
});
    

サポート言語

言語名 エイリアス
Apache apache、apacheconf
Bash bash、sh、zsh
CoffeeScript coffeescript、coffee、cson、iced
CPP cpp
CS cs
CSS css
Diff diff、patch
Dockerfile dockerfile、docker
Go go、golang
HTTP http、https
INI ini
Java java、jsp
JavaScript javascript、js、jsx
JSON json
Less less
Lua lua
Makefile makefile、mk、mak
Markdwon markdown、md、mkdown、mkd
NGINX nginx、nginxconf
Objective-C onjectivec、mm、objc、obj-c
Perl perl、pl、pm
PHP php、php3、php4、php5、php6
Python python、py、gyp
RIB rib
RSL rsl
Ruby ruby、rb、gemspec、podspec、thor、irb
SCSS scss
SQL sql
XML xml
YAML yml
注: 希望する言語が見つからない場合にはお知らせください。

水平線

新しい行に --- または *** を追加すると、水平線になります。

Two paragraphs

---

Separated by a line
フォローする

0 コメント

ログインしてコメントを残してください。