Merge pull request #152 from ClaireggZ/feat/use-md-by-default

fix(contrib): change default submission file extension from .mdx to .md

Author: Mira190

CONTRIBUTING.md

@@ -127,7 +127,7 @@ pnpm dev
 
 打开浏览器访问 [http://localhost:3000](http://localhost:3000)。
 
-修改 `docs/` 下的 `.md` 或 `.mdx` 文件，会自动热更新。
+修改 `docs/` 下的 `.md` 文件，会自动热更新。
 
 ---
 
@@ -155,7 +155,7 @@ pnpm postinstall     # 同步必要的 Husky/Fumadocs 配置
 docxA 引用了 imgA 图片, 那么他们的文档结构应该是 `docxA.assets/imgA`:
 
 ```md
-docsA.mdx
+docsA.md
 docsA.assets/
 imgA
 ```
@@ -199,35 +199,35 @@ tags:
 ```
 📂 docs/
 ├── 📂 computer-science/           # 计算机科学
-│   ├── 📄 index.mdx               # 概述
+│   ├── 📄 index.md               # 概述
 │   └── 📂 data-structures/        # 数据结构
-│       ├── 📄 index.mdx           # 概述
+│       ├── 📄 index.md           # 概述
 │       ├── 📂 array/              # 数组
-│       │   ├── 📄 index.mdx       # 概述
-│       │   ├── 📄 01-static-array.mdx    # 静态数组
-│       │   └── 📄 02-dynamic-array.mdx   # 动态数组
+│       │   ├── 📄 index.md       # 概述
+│       │   ├── 📄 01-static-array.md    # 静态数组
+│       │   └── 📄 02-dynamic-array.md   # 动态数组
 │       └── 📂 linked-list/        # 链表
-│           ├── 📄 index.mdx       # 概述
-│           └── 📄 01-singly-linked-list.mdx  # 单向链表
+│           ├── 📄 index.md       # 概述
+│           └── 📄 01-singly-linked-list.md  # 单向链表
 ```
 
 ### URL 生成
 
 文件结构会自动生成简洁的 URL：
 
-- `docs/computer-science/index.mdx` → `/computer-science`
-- `docs/computer-science/data-structures/array/01-static-array.mdx` → `/computer-science/data-structures/array/static-array`
+- `docs/computer-science/index.md` → `/computer-science`
+- `docs/computer-science/data-structures/array/01-static-array.md` → `/computer-science/data-structures/array/static-array`
 
 ### 命名约定
 
 **文件夹:**
 
 - 使用 `kebab-case` 命名: `computer-science`, `data-structures`
-- 每个主题文件夹应该有一个 `index.mdx` 文件作为概述
+- 每个主题文件夹应该有一个 `index.md` 文件作为概述
 
 **文件:**
 
-- 使用 `kebab-case` 命名: `static-array.mdx`
+- 使用 `kebab-case` 命名: `static-array.md`
 - 使用数字前缀排序: `01-`, `02-`
 - 前缀会自动从最终 URL 中移除
 

app/components/Contribute.tsx

@@ -27,7 +27,7 @@ const FILENAME_PATTERN = /^[A-Za-z0-9][A-Za-z0-9_-]+$/;
 
 // 统一调用工具函数生成 GitHub 新建链接，路径规则与 Edit 按钮一致
 function buildGithubNewUrl(dirPath: string, filename: string, title: string) {
-  const file = filename.endsWith(".mdx") ? filename : `${filename}.mdx`;
+  const file = filename.endsWith(".md") ? filename : `${filename}.md`;
   const frontMatter = `---
 title: '${title || "New Article"}'
 description: ""

scripts/check-images.mjs

@@ -3,7 +3,7 @@
  * MDX 图片路径校验脚本
  *
  * 功能
- * - 扫描 `app/docs/??/?.mdx`（含 .md）
+ * - 扫描 `app/docs/??/?.md`（含 .mdx）
  * - 识别 Markdown `![]()` 与内联 `<img src="…" />` 的图片引用
  * - 强制使用“就近图片”：推荐相对路径（如 `./images/…`）
  * - 仅对站点级共享资源允许绝对路径：`/images/site/*`、`/images/components/*`
@@ -38,7 +38,7 @@ const IMAGE_FILE_EXTS = new Set([
   ".webp",
   ".svg",
 ]);
-const exts = new Set([".mdx", ".md"]);
+const exts = new Set([".md", ".mdx"]);
 
 /** Recursively list files */
 function* walk(dir) {
@@ -60,7 +60,7 @@ function toRoutePath(file) {
   const rel = path.relative(DOCS_DIR, file).split(path.sep).join("/");
   const base = path.basename(rel);
   const dir = path.dirname(rel);
-  if (base.toLowerCase() === "index.mdx") return dir === "." ? "" : dir;
+  if (base.toLowerCase() === "index.md") return dir === "." ? "" : dir;
   const name = base.replace(/\.[^.]+$/, "");
   return dir === "." ? name : `${dir}/${name}`;
 }
@@ -207,7 +207,7 @@ function main() {
     console.log(`\nFound ${bad}/${total} files with image issues.`);
     process.exit(1);
   } else {
-    console.log(`Checked ${total} MDX files: no issues.`);
+    console.log(`Checked ${total} MD files: no issues.`);
   }
 }
 

scripts/escape-angles.mjs

@@ -12,7 +12,7 @@ import fg from "fast-glob";
  * 2) 仅在普通文本行内转义形如 <数字开头...> 或 <单词里含逗号/空格/数学符号...> 的片段
  * 3) 不动像 <Component> / <div> 这类“正常标签/组件名”的片段
  */
-const files = await fg(["app/docs/**/*.mdx"], { dot: false });
+const files = await fg(["app/docs/**/*.md"], { dot: false });
 
 for (const file of files) {
   let src = await fs.readFile(file, "utf8");

scripts/move-doc-images.mjs

@@ -1,10 +1,10 @@
 #!/usr/bin/env node
 /**
- * MDX 图片就近迁移脚本（中文注释）
+ * MD 图片就近迁移脚本（中文注释）
  *
  * 目标
- * - 扫描 `app/docs/??/?.mdx`（含 .md）里的图片引用
- * - 对于以 `/images/...` 绝对路径引用且仅被“单一文档”使用的图片：移动到对应 MDX 同目录下的 `images/` 子目录
+ * - 扫描 `app/docs/??/?.md`（含 .mdx）里的图片引用
+ * - 对于以 `/images/...` 绝对路径引用且仅被“单一文档”使用的图片：移动到对应 MD 同目录下的 `images/` 子目录
  * - 同时将文中的绝对路径替换为相对路径 `./images/<文件名>`（站点级资源除外）
  *
  * 为什么需要
@@ -34,7 +34,7 @@ const PUBLIC_DIR = path.join(ROOT, "public");
 const EXCLUDE_PREFIXES = ["/images/site/", "/images/components/"];
 
 // 需要处理的文档扩展名
-const exts = new Set([".mdx", ".md"]);
+const exts = new Set([".md", ".mdx"]);
 
 /** 递归遍历目录，产出文件路径 */
 function* walk(dir) {
@@ -222,7 +222,7 @@ function moveForFile(file, refs) {
   return { moved, updated: content !== raw };
 }
 
-/** 主流程：遍历所有 MDX，累计迁移数量并输出统计 */
+/** 主流程：遍历所有 MD，累计迁移数量并输出统计 */
 function main() {
   let totalFiles = 0;
   let totalMoved = 0;