Jamdesk Documentation logo

编写与组织概览

Jamdesk 页面编写相关内容:MDX 语法、代码块、媒体嵌入、SEO,以及在发布前预览的工具。

Jamdesk 页面是 MDX 文件:标准 Markdown,并可在需要的地方使用 React 组件。一个页面由 frontmatter 和正文内容组成。

---
title: Rate Limits
description: How rate limiting works across API tiers.
---

Requests are limited per API key.

<Note>Enterprise plans have custom limits.</Note>

你编写的大部分内容都是普通 Markdown。本节的页面涵盖其余部分:带语法高亮的代码块、图片和视频、数学公式、可复用的代码片段,以及控制标题、图标和 SEO 元数据的 frontmatter 字段。

MDX 与页面

MDX 基础

嵌入 React 组件的 Markdown。从这里开始。

代码块

语法高亮、行号、文件名和 CodeGroup

自定义 React 组件

使用服务端渲染和 Tailwind 定义你自己的组件

Frontmatter

标题、描述、图标、侧边栏覆盖和 SEO 元数据

标题

用于生成目录的 H2 和 H3 标题

图标

卡片、提示框、导航和行内文本中的 Font Awesome Pro 图标

链接与锚点

内部链接、标题锚点和外部 URL

数学与 LaTeX

使用 KaTeX 渲染方程和表达式

SEO

元标签、社交预览和自动生成的站点地图

隐藏页面

不删除页面的前提下,将其从侧边栏和搜索中隐藏

代码片段

可在多个页面中导入的可复用内容块

媒体与嵌入

图片

尺寸、说明文字、明暗主题变体和支持的格式

YouTube

延迟加载的视频和 Shorts,支持自定义开始时间

视频

MP4 和 WebM,支持自动播放、循环和封面图属性

iFrame

Vimeo、CodePen、Figma、Loom 和其他外部嵌入内容

编写工具

你无需推送代码即可查看更改。可以使用 CLI 在本地预览,在浏览器中编辑,或从 VS Code 控制开发服务器。

本地预览

在本机运行文档,支持即时重新加载

网页编辑器

在浏览器中编辑 MDX 并实时预览,直接提交到你的仓库

VS Code 扩展

从状态栏启动和停止开发服务器