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。从这里开始。

代码块

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

自定义 React 组件

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

Frontmatter

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

标题

用于填充目录的 H2 和 H3 标题

图标

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

链接与锚点

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

数学与 LaTeX

用于渲染方程和表达式的 KaTeX

SEO

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

隐藏页面

将页面从侧边栏和搜索结果中隐藏,而无需删除页面

片段

可跨页面导入的可复用内容块

媒体与嵌入

图片

尺寸、标题、明暗变体和支持的格式

YouTube

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

视频

支持自动播放、循环播放和 poster 属性的 MP4 与 WebM

iFrames

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

编写工具

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

本地预览

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

网页编辑器

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

VS Code 扩展

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