文档转换器添加跳转链接转换的逻辑

Author: Yesifan

darkit/core/web/vite-plugin-docs.ts

@@ -19,6 +19,7 @@ type DocsTree =
 			title: string;
 			path: string;
 	  };
+
 const isPathIn = (a: string, b: string) => {
 	const relative = path.relative(b, a);
 	return !relative.startsWith('..') && !path.isAbsolute(relative);
@@ -77,13 +78,14 @@ const removeDocsCache = async (target: string) => {
 };
 
 /**
- * 将 markdown 文件中的静态资源引用转换为相对路径
+ * 将 markdown 文件中的静态资源引用转换为 web 路径，将链接路径页转换为 web 路径
  * @returns { content: string, staticFiles: [string, string][] } 转换后的 markdown 内容和静态资源文件路径
  * staticFiles 为 [源文件路径, 相对路径] 的数组
  */
 const transformMarkdown = async (sourceDir: string) => {
 	const content = await fs.readFile(sourceDir, 'utf-8');
 	const staticFiles: [string, string][] = [];
+	// 将 markdown 文件中的本地静态资源引用转换为 web 路径， 并将本地文件路径读取出来
 	const updatedContent = content.replace(/!\[.*?\]\((\/.*?)(?:\s".*?")?\)/g, (match, p1) => {
 		const staticFile = path.isAbsolute(p1) ? path.join(ROOT_PATH, p1) : path.join(sourceDir, p1);
 		// 如果是网络文件则跳过
@@ -98,9 +100,29 @@ const transformMarkdown = async (sourceDir: string) => {
 			);
 		}
 	});
-	return { content: updatedContent, staticFiles };
+	// 将 markdown 文件中的链接路径转换为 web 路径
+	const finalContent = updatedContent.replace(/\[.*?\]\((.*?).md\)/g, (match, p1) => {
+		// 如果是网络文件则跳过
+		if (p1.startsWith('http')) return match;
+		const newUrl = (p1 as string)
+			.split('/')
+			.map((segment) => {
+				if (segment !== '.' && segment !== '..' && segment.includes('.')) {
+					return segment.split('.')[1];
+				}
+				return segment;
+			})
+			.join('/');
+
+		return match.replace(`${p1}.md`, newUrl);
+	});
+	return { content: finalContent, staticFiles };
 };
 
+/**
+ * 文件夹和文档的命名需要符合“序号.标题”格式
+ * 构建到 svelte 中时根据序号排序，标题作为 svelte 文件夹和组件的名称
+ */
 export const docs = ({
 	source,
 	target,

docs/1.Introduction/1.About.md

@@ -1,7 +1,7 @@
 # About
-本仓库是一个基于 PyTorch 的自然语言处理工具包，提供了一些常用的 NLP 模型和工具。
+DarwinKit is a PyTorch-based NLP toolkit that provides some commonly used NLP models and tools.
 
 ## Getting Started For Users
 You can read the following documents to start using this repository:
-- [Installation](/docs/User-guide/Installation-guide)
-- [Tutorials](/docs/User-guide/How-use-web)
+- [Installation](../2.User-guide/1.Installation-guide.md)
+- [Tutorials](../2.User-guide/2.How-use-web.md)

docs/zh/1.Introduction/1.About.md

@@ -3,5 +3,5 @@
 
 ## 用户入门指南
 您可以阅读以下文档来开始使用该仓库：
-- [安装指南](/docs/User-guide/Installation-guide)
-- [教程](/docs/User-guide/How-use-web)
+- [安装指南](../2.User-guide/1.Installation-guide.md)
+- [教程](../2.User-guide/2.How-use-web.md)