如果要插入跨行片段或块,且要保持排版样式(包括空格、换行符和缩进),可使用预格式化引用语法格式。对应 HTML 中的 <pre>
标签。
在句段的行首插入1个tab 或 4个空格,则表示代码块。
如果要支持编程语言语法高亮,则可以使用 GFM 扩展的基于 YAML 标记语言的 Fenced Code Block 引用语法格式。
在句段行首三个反引号后添加 YAML 语言标识,段落行末用三个反引号换行闭包即可。
Writing on GitHub / Creating and highlighting code blocks
We use Linguist to perform language detection and syntax highlighting. You can find out which keywords are valid in the languages YAML file.
以下为 FoldingText 显式支持的语言标签:
- xml
- yaml
- json
- sql
- markdown
- c
- C++(
cpp
) - Objective-C(
obj-c
、objc
、objectivec
) - Swift
- csharp
- java
- go
- scala
- erlang
- r
- html
- css
- javascript
- ecmascript
- typescript
- coffeescript
- php
- ruby
- perl
- python
- shell
- log
The built in syntax highlighting will recognize 41+ different language specifiers. If there is no language specified, it will detect it automatically, so it’s not required for the preview. The language string given will be output in the final html as a class on the
<code>
tag.