:enhance: 增强文本块导入能力

Author: zyao89

docs/markdown/advance/5-import.md

@@ -1,7 +1,7 @@
 # 导入代码段
 
 ::: tip 注意
-由于代码段的导入将在 webpack 编译之前执行，因此你无法使用 webpack 中的路径别名，默认基于文档更目录开始。
+由于代码段的导入将在 webpack 编译之前执行，因此你无法使用 webpack 中的路径别名，因此加载逻辑分为三层，`node_modules` > `@`（文档根目录） > 相对目录。
 :::
 
 

docs/markdown/advance/6-include.md

@@ -1,7 +1,7 @@
 # 导入文本
 
 ::: tip 注意
-由于代码段的导入将在 webpack 编译之前执行，因此你无法使用 webpack 中的路径别名，默认基于文档更目录开始。
+由于代码段的导入将在 webpack 编译之前执行，因此你无法使用 webpack 中的路径别名，`node_modules` > `@`（文档根目录） > 相对目录。
 :::
 
 ::: warning 注意

theme/index.js

@@ -93,6 +93,15 @@ module.exports = (options, ctx) => {
         },
         extendMarkdown: md => {
             md.set({ breaks: true });
+
+            const render = md.render
+            md.render = (...args) => {
+                if (args.length > 1) {
+                    const [, { relativePath }] = args;
+                    md.$relativePath = relativePath;
+                }
+                return render.call(md, ...args);
+            };
         },
         chainMarkdown(config) {
             config
@@ -119,12 +128,17 @@ module.exports = (options, ctx) => {
             // include
             config.plugin('include').use(require('./plugins/markdown/markdown-it-include'), [ {
                 root: sourceDir, // root path
-                includeRe: /<<<include(.+)/i,
+                includeRe: /<{3}include(.+)/i,
                 bracesAreOptional: true,
                 getRootDir(pluginOptions, state, startLine, endLine) {
                     // const pos = state.bMarks[startLine] + state.tShift[startLine]
                     // const max = state.eMarks[startLine]
-                    return pluginOptions.root;
+                    const root = pluginOptions.root;
+                    const { $relativePath } = state.md || {};
+                    if (!$relativePath) {
+                        return root;
+                    }
+                    return path.resolve(root, path.dirname($relativePath));
                 },
             } ])
 

theme/plugins/markdown/markdown-it-include.js

@@ -52,7 +52,12 @@ const include_plugin = (md, options) => {
       }
 
       if (!errorMessage) {
-        const [ _includePath, _regionName ] = includePath ? includePath.split('#') : [''];
+        let [ _includePath, _regionName ] = includePath ? includePath.split('#') : [''];
+        try {
+          _includePath = require.resolve(_includePath);
+        } catch (e) {
+          _includePath = _includePath.trim().replace(/^@/, rootdir).trim()
+        }
         filePath = path.resolve(rootdir, _includePath);
         regionName = _regionName;
 
@@ -111,7 +116,8 @@ const include_plugin = (md, options) => {
   };
 
   const _includeFileParts = (state, startLine, endLine/*, silent*/) => {
-    state.src = _replaceIncludeByContent(state.src, options.getRootDir(options, state, startLine, endLine));
+    const root = options.getRootDir(options, state, startLine, endLine);
+    state.src = _replaceIncludeByContent(state.src, root);
   };
 
   md.core.ruler.before('normalize', 'include', _includeFileParts);

theme/plugins/markdown/snippet/index.js

@@ -42,6 +42,7 @@ module.exports = function snippet (md, options = {}) {
   }
 
   function parser (state, startLine, endLine, silent) {
+    const { $relativePath } = state.md || {};
     const CH = '<'.charCodeAt(0)
     const pos = state.bMarks[startLine] + state.tShift[startLine]
     const max = state.eMarks[startLine]
@@ -76,14 +77,24 @@ module.exports = function snippet (md, options = {}) {
      */
     const rawPathRegexp = /^(.+?(?:\.([a-z]+))?)(?:(#[\w-]+))?(?: ?({\d+(?:[,-]\d+)*}))?$/
 
-    const rawPath = state.src.slice(start, end).trim()
+    // 通过 @ 识别根目录
+    const rawPath = state.src.slice(start, end).trim();
     const [filename = '', extension = '', region = '', meta = ''] = (rawPathRegexp.exec(rawPath) || []).slice(1)
+    let _filename = filename;
+    try {
+      _filename = require.resolve(_filename);
+    } catch (error) {
+      _filename = _filename.replace(/^@/, root).trim();
+    }
 
     state.line = startLine + 1
 
     const token = state.push('fence', 'code', 0)
     token.info = extension + meta
-    token.src = path.resolve(root, filename) + region
+    token.src = ($relativePath 
+      ? path.resolve(root, path.dirname($relativePath), _filename)  // 相对路径
+      : path.resolve(root, _filename)) + region
+    // token.src = path.resolve(root, filename) + region
     token.markup = '```'
     token.map = [startLine, startLine + 1]