feat: support attrlink in Front-matter

Author: MuYunyun

config.yml

@@ -11,10 +11,11 @@ menu: [
   docs/更新日志.md,
   docs/主题,
   docs/站点发布.md,
-  docs/其它工具.md,
-  docs/书写组件.md,
+  docs/Front-matter.md,
   docs/数学公式.md,
+  docs/书写组件.md,
   docs/高阶用法.md,
+  docs/其它工具.md,
 ]
 ## set init open menu keys
 # menuOpenKeys:

docs/Front-matter.md

@@ -0,0 +1,19 @@
+<!--
+abbrlink: 49g6b239
+-->
+
+## Front-matter
+
+Front-matter 是文件最上方包裹在 `<!--` 与 `-->` 之间的区域，用于指定个别文件的变量，举例来说：
+
+```md
+<!--
+abbrlink: 290a4219
+-->
+```
+
+以下是预先定义的参数，您可在模板中使用这些参数值并加以利用。
+
+| 参数     | 描述                                                            | 默认值 |
+| :------- | :-------------------------------------------------------------- | :----- |
+| abbrlink | 短链。用于指定页面路由展示为指定短链，使用短链有助于 SEO 搜索。 |        |

docs/主题/默认主题.md

@@ -1,9 +1,3 @@
-<!--
-title: 默认主题
-abbrlink: f55182c5
-date: 2019-05-12 13:23:44
--->
-
 ## 默认主题
 
 create-react-doc 的默认主题为 [crd-seed](https://github.com/MuYunyun/create-react-doc/tree/main/packages/crd-seed)。该主题有以下特性:

docs/更新日志.md

@@ -2,6 +2,15 @@
 
 `create-react-doc` 严格遵循 [Semantic Versioning 2.0.0](http://semver.org/lang/zh-CN/) 语义化版本规范。
 
+### 1.4.0
+
+`2021-10-08`
+
+- **Feature**
+
+  - 🚀 支持展示短链以让文章链接持久化。[issue](https://github.com/MuYunyun/create-react-doc/issues/87)、[mr](https://github.com/MuYunyun/create-react-doc/pull/193)
+    - 🚀 支持在 Front-matter 区域中书写个别文件的变量。
+
 ### 1.3.5
 
 `2021-09-24`

packages/crd-seed/layout/index.js

@@ -43,7 +43,6 @@ function BasicLayout({
 
   useEffect(() => {
     const newPathName = location.pathname
-    // setSelectedKey(`${newPathName}.md`)
     setSelectedKey(newPathName)
   }, location)
 
@@ -115,7 +114,6 @@ function BasicLayout({
           }}
           selectedKey={selectedKey}
           onSelect={(keyValue) => {
-            console.log('keyValue', keyValue)
             setSelectedKey(keyValue)
           }}
           defaultOpenKeys={curOpenKeys}

packages/scripts/src/conf/getPrerenderRoutes.js

@@ -28,18 +28,20 @@ function recursive(data, routePath, arr) {
   data.forEach((item) => {
     const { mdconf } = item || {}
     const { abbrlink } = mdconf || {}
-    const routePropsCurrent = abbrlink
-      ? `/${abbrlink}`
-      : `${routePath}/${item.name}`.replace(/.md$/, '')
+    const composeRouteName = `${routePath}/${item.name}`.replace(/.md$/, '')
+
     if (item.type === 'directory') {
       if (item.children && item.children.length > 0) {
         // eslint-disable-next-line no-unused-vars
-        item.children = recursive(item.children, routePropsCurrent, arr)
+        item.children = recursive(item.children, composeRouteName, arr)
       } else {
         item.children = []
       }
     } else if (item.type === 'file') {
-      arr.push(routePropsCurrent)
+      const prerenderRouteName = abbrlink
+        ? `/${abbrlink}`
+        : composeRouteName
+      arr.push(prerenderRouteName)
     }
   })
   return arr

packages/scripts/src/conf/webpack.config.prod.js

@@ -123,11 +123,6 @@ module.exports = function (cmd) {
 
   const routes = getPrerenderRoutes(cmd)
 
-  console.log('docsConfig.repo', docsConfig.repo,)
-  console.log('outputDir', docsConfig.repo ? `${docsBuildDist}/${docsConfig.repo}` : docsBuildDist,)
-  console.log('indexPath', docsConfig.repo ? `${docsBuildDist}/${docsConfig.repo}/index.html` : `${docsBuildDist}/index.html`,)
-  console.log('✅ routes', routes)
-
   config.plugins = config.plugins.concat([
     new webpack.DefinePlugin({
       env: JSON.stringify('prod'),
@@ -169,11 +164,6 @@ module.exports = function (cmd) {
         : `${docsBuildDist}/index.html`,
       // Required - Routes to render.
       routes,
-      // routes: [
-      //   '/README', '/快速上手',
-      //   '/290a4219', '/9f41fc98',
-      //   '/f55182c5'
-      // ],
       successCb: async () => {
         if (docsConfig.repo) {
           // not use fs.move here or it'll throw error in github action