Y. YINCHAOJI / 思考 · 构建 · 记录
← 所有文章
工程实践 / 2026.10.30 / 约 2 分钟

让文档多一点表达力:Markdown 与 MDX

文字、代码和组件可以放在同一篇文章里。用一个提示框,演示 MDX 的最小用法。

从 Markdown 开始

日常文章使用 Markdown 就够了:标题、列表、引用、链接和代码块,足以解释大多数技术问题。

const note = { title: '持续记录', published: true };
console.log(note.title);

在 MDX 中使用组件

组件适合表达重复的内容结构,例如提示、术语说明或对比表。无需为了普通段落引入组件。

写作约定

  • 文件名使用稳定的英文短横线格式,避免后续改动文章地址。
  • description 用一句话说明文章能帮助读者解决什么问题。
  • 未完成文章设置 draft: true,不会进入公开构建。

这篇文章是功能示例,可以改写为你的第一篇正式笔记。

← 继续阅读其他文章