跳转到主要内容

​
添加代码示例

你可以添加行内代码片段或代码块。代码块支持用于语法高亮、title、行高亮、icon 等的元选项，以及更多功能。

​
行内代码

要将 word 或 phrase 表示为代码，请用反引号（`）包裹。 
要将`单词`或`短语`标记为代码，请用反引号（`）将其包围。

​
代码块

使用围栏代码块，用三个反引号包裹代码。代码块可复制；如果启用了 AI 助手，用户还可以让 AI 解释代码。 为实现语法高亮并启用元选项，请指定编程语言。在语言标识之后添加任意元选项，例如标题或 icon。 
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

​
代码块选项

你可以为代码块添加元选项，以自定义其显示效果。
在添加任何其他元选项之前，必须先为代码块指定编程语言。

​
选项语法

  • 字符串与布尔选项：可用 ""、''，或不加引号包裹。
  • 表达式选项：可用 {}、""，或 '' 包裹。

​
语法高亮

在代码块的起始反引号后添加编程语言以启用语法高亮。 我们使用 Shiki 实现语法高亮，并支持其提供的所有语言。完整列表请参见 Shiki 文档中的语言。 在 docs.json 文件中通过 styling.codeblocks 全局自定义代码块主题。你可以设置 system 或 dark 等简单主题，或为浅色与深色模式配置自定义的 Shiki 主题。配置选项见 Settings。 
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}

​
Twoslash

在 JavaScript 和 TypeScript 代码块中，使用 twoslash 可启用交互式类型信息。用户可以像在 IDE 中一样，将鼠标悬停在变量、函数和参数上，以查看类型与错误提示。 
type  = "cat" | "dog" | "hamster";

function (: string, : ) {
  return `${} the ${} is now adopted!`;
}

// 悬停以查看推断的类型
const  = ("Mintie", "cat");

​
标题

为代码示例添加一个标题。使用 title="Your title"，或在单行中添加字符串。 
const hello = "world";

​
图标

使用 icon 属性为代码块添加图标。请参阅 图标 了解所有可用选项。 
const hello = "world";

​
行高亮

在代码块中使用 highlight 并指定要高亮的行号或范围，以突出显示特定行。 
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

​
行聚焦

在代码块中使用带有行号或范围的 focus 来突出显示特定行。 
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

​
显示行号

使用 lines 在代码块左侧显示行号。 
const greeting = "Hello, World!";
function sayHello() {
  console.log(greeting);
}
sayHello();

​
可展开

使用 expandable 让用户展开或折叠较长的代码块。 
from datetime import datetime, timedelta
from typing import Dict, List, Optional
from dataclasses import dataclass

@dataclass
class Book:
    title: str
    author: str
    isbn: str
    checked_out: bool = False
    due_date: Optional[datetime] = None

class Library:
    def __init__(self):
        self.books: Dict[str, Book] = {}
        self.checkouts: Dict[str, List[str]] = {}  # patron -> list of ISBNs

    def add_book(self, book: Book) -> None:
        if book.isbn in self.books:
            raise ValueError(f"Book with ISBN {book.isbn} already exists")
        self.books[book.isbn] = book

    def checkout_book(self, isbn: str, patron: str, days: int = 14) -> None:
        if patron not in self.checkouts:
            self.checkouts[patron] = []

        book = self.books.get(isbn)
        if not book:
            raise ValueError("Book not found")

        if book.checked_out:
            raise ValueError("Book is already checked out")

        if len(self.checkouts[patron]) >= 3:
            raise ValueError("Patron has reached checkout limit")

        book.checked_out = True
        book.due_date = datetime.now() + timedelta(days=days)
        self.checkouts[patron].append(isbn)

    def return_book(self, isbn: str) -> float:
        book = self.books.get(isbn)
        if not book or not book.checked_out:
            raise ValueError("Book not found or not checked out")

        late_fee = 0.0
        if datetime.now() > book.due_date:
            days_late = (datetime.now() - book.due_date).days
            late_fee = days_late * 0.50

        book.checked_out = False
        book.due_date = None

        # Remove from patron's checkouts
        for patron, books in self.checkouts.items():
            if isbn in books:
                books.remove(isbn)
                break

        return late_fee

    def search(self, query: str) -> List[Book]:
        query = query.lower()
        return [
            book for book in self.books.values()
            if query in book.title.lower() or query in book.author.lower()
        ]

def main():
    library = Library()

    # Add some books
    books = [
        Book("The Hobbit", "J.R.R. Tolkien", "978-0-261-10295-4"),
        Book("1984", "George Orwell", "978-0-452-28423-4"),
    ]

    for book in books:
        library.add_book(book)

    # Checkout and return example
    library.checkout_book("978-0-261-10295-4", "patron123")
    late_fee = library.return_book("978-0-261-10295-4")
    print(f"Late fee: ${late_fee:.2f}")

if __name__ == "__main__":
    main()

​
自动换行

使用 wrap 为长行启用自动换行。这样可以避免水平滚动，并使长行更易阅读。 
const greeting = "Hello, World! I am a long line of text that will wrap to the next line.";
function sayHello() {
  console.log(greeting);
}
sayHello();

​
Diff

在代码块中以可视化方式展示新增或删除的行。新增行将以绿色高亮，删除行将以红色高亮。 要创建差异，请在代码块中目标行的末尾添加以下特殊注释：
  • // [!code ++]：将该行标记为新增（绿色高亮）。
  • // [!code --]：将该行标记为删除（红色高亮）。
对于多行连续的更改，可在冒号后指定行数：
  • // [!code ++:3]：将当前行及其后两行标记为新增。
  • // [!code --:5]：将当前行及其后四行标记为删除。
注释语法须与所用编程语言一致（例如，JavaScript 使用 //，Python 使用 #）。 
const greeting = "Hello, World!"; 
function sayHello() {
  console.log("Hello, World!"); 
  console.log(greeting); 
}
sayHello();
⌘I