你可以添加行内代码片段或代码块。代码块支持用于语法高亮、标题、行高亮、icon 等的元选项,及其他功能。
要将某个 word
或 phrase
标记为代码,请用反引号(`)将其包裹。
要将`单词`或`短语`标记为代码,请用反引号(`)将其包围。
使用fenced code blocks,用三个反引号包裹代码。代码块支持复制;如果启用了 AI 助手,用户还可以让 AI 解释代码。
为语法高亮和启用元选项指定编程语言。在语言后添加任意元选项,例如 title 或 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!");
}
}
在 JavaScript 和 TypeScript 代码块中,使用 twoslash
可启用交互式类型信息。用户可以像在 IDE 中一样,将鼠标悬停在变量、函数和参数上查看类型与错误。
type Pet = "cat" | "dog" | "hamster";
function adoptPet(name: string, type: Pet) {
return `${name} the ${type} is now adopted!`;
}
// 将鼠标悬停以查看推断的类型
const message = adoptPet("Mintie", "cat");
为代码示例添加一个标题。使用 title="Your title"
,或在单独一行提供字符串。
使用 icon
属性为代码块添加图标。参见 Icons 以查看所有可用选项。
在代码块中使用带有行号或范围的 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]] = {} # 读者 -> ISBN 列表
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
# 从读者的借阅列表中移除
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()
# 添加一些书籍
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)
# 借阅与归还示例
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();
在代码块中直观展示新增或删除的行。新增行以绿色高亮,删除行以红色高亮。
要创建差异,请在代码块每行末尾添加以下特殊注释:
// [!code ++]
:将该行标记为新增(绿色高亮)。
// [!code --]
:将该行标记为删除(红色高亮)。
对于连续多行,可在冒号后指定行数:
// [!code ++:3]
:将当前行及接下来的两行标记为新增。
// [!code --:5]
:将当前行及接下来的四行标记为删除。
注释语法必须与你所用的编程语言一致(例如,JavaScript 使用 //
,Python 使用 #
)。
const greeting = "Hello, World!";
function sayHello() {
console.log("Hello, World!");
console.log(greeting);
}
sayHello();