Jamdesk Documentation logo

标题

使用 H2 和 H3 标题组织页面结构,它们会自动填充右侧目录,并生成可分享的锚点链接。

Markdown 标题(##、###)将页面划分为多个章节。Jamdesk 会将 H2 和 H3 标题添加到右侧目录中,并为每个标题生成可分享的锚点链接。

基本用法

使用标准的 Markdown 标题来组织内容:

## Section Title

Content goes here...

### Subsection

More detailed content...

右侧的 目录 列出 H2 和 H3 标题。读者可以通过它在长页面的各章节之间快速跳转。

锚点链接

每个标题都会根据其文本生成一个锚点 ID:

标题生成的锚点
## Getting Started#getting-started
## API Reference#api-reference
### User Authentication#user-authentication

分享标题链接

将鼠标悬停在任意 H2 或 H3 标题上,即可显示 链接图标:

  • 点击链接图标 可将 URL 复制到剪贴板
  • 点击标题文本 可复制 URL 并跳转到该章节

链接图标会显示在标题左侧的一个小边框方框中。图标会短暂变色,以确认已完成复制。

移动设备没有悬停状态,因此链接图标在移动端会被隐藏。标题仍可用于导航。

链接到标题

使用锚点引用其他页面中的特定章节:

See the [headings section](/content/mdx-basics#headings) for details.

最佳实践

主要章节使用 H2,子章节使用 H3:

## Installation

### Prerequisites

### Quick Install

## Configuration

### Basic Options

### Advanced Options

避免跳过层级(例如从 H2 直接跳到 H4)。

简短的标题更易于浏览:

{/* Good */}
## Authentication

{/* Avoid */}
## How to Set Up Authentication in Your Application

仅将第一个单词和专有名词首字母大写:

{/* Good */}
## Getting started with the API

{/* Avoid */}
## Getting Started With The API

后续内容

SEO 优化

提升可发现性和元数据

Frontmatter

定义标题、描述和 SEO 字段