Skip to content

Commit bbe317b

Browse files
longsizhuolongsizhuo
committed
refactor: 提取 GitHub 相关工具函数，简化文档编辑链接生成逻辑
1 parent d410610 commit bbe317b

5 files changed

Lines changed: 63 additions & 12 deletions

File tree

‎app/components/Contribute.tsx‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,13 @@ import styles from "./Contribute.module.css";
1919
import { TreeSelect } from "antd";
2020
import type { DefaultOptionType } from "antd/es/select";
2121
import { DataNode } from "antd/es/tree";
22-
23-
const REPO_OWNER = "InvolutionHell";
24-
const REPO_NAME = "involutionhell.github.io";
25-
const DEFAULT_BRANCH = "main";
26-
const DOCS_BASE = "app/docs";
22+
import { buildDocsNewUrl } from "@/lib/github";
2723

2824
type DirNode = { name: string; path: string; children?: DirNode[] };
2925

26+
// 统一调用工具函数生成 GitHub 新建链接，路径规则与 Edit 按钮一致
3027
function buildGithubNewUrl(dirPath: string, filename: string, title: string) {
3128
const file = filename.endsWith(".mdx") ? filename : `${filename}.mdx`;
32-
const fullDir = `${DOCS_BASE}/${dirPath}`.replace(/\/+/g, "/");
3329
const frontMatter = `---
3430
title: ${title || "New Article"}
3531
description:
@@ -42,7 +38,7 @@ tags: []
4238
Write your content here.
4339
`;
4440
const params = new URLSearchParams({ filename: file, value: frontMatter });
45-
return `https://github.com/${REPO_OWNER}/${REPO_NAME}/new/${DEFAULT_BRANCH}/${encodeURIComponent(fullDir)}?${params.toString()}`;
41+
return buildDocsNewUrl(dirPath, params);
4642
}
4743

4844
// ✅ 用纯文本 label + 一级节点 selectable:false

‎app/components/EditOnGithub.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import Link from "next/link";
22

3+
// 复用的编辑链接按钮，统一封装图标与样式
34
interface EditOnGithubProps {
45
href: string;
56
}

‎app/docs/[...slug]/page.tsx‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import type { Metadata } from "next";
55
import { getMDXComponents } from "@/mdx-components";
66
import { GiscusComments } from "@/app/components/GiscusComments";
77
import { EditOnGithub } from "@/app/components/EditOnGithub";
8+
import { buildDocsEditUrl } from "@/lib/github";
89

910
interface Param {
1011
params: Promise<{
@@ -20,11 +21,8 @@ export default async function DocPage({ params }: Param) {
2021
notFound();
2122
}
2223

23-
const encodedPath = page.path
24-
.split("/")
25-
.map((segment) => encodeURIComponent(segment))
26-
.join("/");
27-
const editUrl = `https://github.com/InvolutionHell/involutionhell.github.io/edit/main/app/docs/${encodedPath}`;
24+
// 统一通过工具函数生成 Edit 链接，内部已处理中文目录编码
25+
const editUrl = buildDocsEditUrl(page.path);
2826

2927
const Mdx = page.data.body;
3028

‎app/layout.tsx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ export default function RootLayout({
3131
<html lang="en" suppressHydrationWarning>
3232
<head>
3333
<link rel="preload" href="/mascot.webp" as="image" type="image/webp" />
34+
{/* 谷歌图标字体用于 Edit 按钮的 material symbol */}
3435
<link
3536
rel="stylesheet"
3637
href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@20..48,100..700,0..1,-50..200&icon_names=edit"

‎lib/github.ts‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
// GitHub 相关工具方法：集中维护仓库常量与文档路径生成逻辑
2+
const GITHUB_OWNER = "InvolutionHell";
3+
const GITHUB_REPO = "involutionhell.github.io";
4+
const DEFAULT_BRANCH = "main";
5+
const DOCS_BASE = "app/docs";
6+
7+
const REPO_BASE_URL = `https://github.com/${GITHUB_OWNER}/${GITHUB_REPO}`;
8+
9+
// 拼接路径并清理多余斜杠，避免出现 // 或首尾斜杠
10+
function joinPath(...segments: (string | undefined)[]) {
11+
return segments
12+
.filter((segment) => (segment ?? "").trim().length > 0)
13+
.join("/")
14+
.replace(/\/+/g, "/")
15+
.replace(/^\/+/, "")
16+
.replace(/\/+$/, "");
17+
}
18+
19+
// 将路径逐段 URL 编码，处理中文等特殊字符
20+
function encodeRepoPath(...segments: (string | undefined)[]) {
21+
const joined = joinPath(...segments);
22+
if (!joined) return "";
23+
return joined
24+
.split("/")
25+
.map((segment) => encodeURIComponent(segment))
26+
.join("/");
27+
}
28+
29+
// 构建文档的 GitHub 编辑链接
30+
export function buildDocsEditUrl(relativeDocPath: string) {
31+
const encoded = encodeRepoPath(DOCS_BASE, relativeDocPath);
32+
return `${REPO_BASE_URL}/edit/${DEFAULT_BRANCH}/${encoded}`;
33+
}
34+
35+
// 构建在 GitHub 新建文档的链接，附带 frontmatter 参数
36+
export function buildDocsNewUrl(relativeDir: string, params: URLSearchParams) {
37+
const encodedDir = encodeRepoPath(DOCS_BASE, relativeDir);
38+
const query = params.toString();
39+
const suffix = query ? `?${query}` : "";
40+
return `${REPO_BASE_URL}/new/${DEFAULT_BRANCH}/${encodedDir}${suffix}`;
41+
}
42+
43+
// 帮助预览完整 docs 路径（未编码）
44+
export function normalizeDocsPath(relative: string) {
45+
return joinPath(DOCS_BASE, relative);
46+
}
47+
48+
// 暴露常量给其他场景复用
49+
export const githubConstants = {
50+
owner: GITHUB_OWNER,
51+
repo: GITHUB_REPO,
52+
defaultBranch: DEFAULT_BRANCH,
53+
docsBase: DOCS_BASE,
54+
repoBaseUrl: REPO_BASE_URL,
55+
};

0 commit comments

Comments
 (0)