使用 Shotgun Markdown 设置文本字段的格式

Shotgun 目前支持 Markdown 在以下位置进行渲染:

  • 注释正文、注释回复和注释电子邮件通知
  • 工单说明、工单回复和工单电子邮件通知。

有关使用背景颜色和字体样式来设置单元格和行的格式的详细信息,请参见“设置记录和字段的格式(手动设置和使用规则设置)”。

Markdown 在 Shotgun 上的实施遵循广泛应用的“Github 风格 Markdown”(GFM) 规范,添加了智能排版引号和一些样式速记属性。

示例

行内级别样式

斜体和粗体

此处,Shotgun 不同于 GFM,引入了更自然的宽松式速记:

Markdown 输出
_italics_ italics
*bold* bold

但对于普通书写粗体,我们保留了 Markdown 标准:

Markdown 输出
__bold__ bold
**bold** bold

删除线

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

链接

Shotgun 将自动链接所识别的 URL 模式,但如果您想指定链接文本,请使用:

Markdown 输出
[Example Site](http://example.com) Example Site

图像

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!!
注意:您也可以使用任意数量的 =- 来设置前两个级别的格式
Title
=

Subtitle
--------

列表

列表很简单:

- One
- Two
- Three

列表可以使用数字或 - 进行有序或无序排列,并且可以随意嵌套(使用四个空格):

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
  • 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
    
    复选框

    块引用

    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
    

    代码块

    代码块在自己的行上用三个重音符进行分隔:

    ```
    ['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
    
    关注