feat(headline): add ability to use custom headline

update dependencies #14
ph1p · Apr 2, 2019 · 8aa34d1 · 8aa34d1
1 parent a9773b9
commit 8aa34d1
Show file tree

Hide file tree

Showing 15 changed files with 1,309 additions and 611 deletions.
diff --git a/README.md b/README.md
@@ -124,10 +124,13 @@ You can add custom meta data your pages by using the `@vuepress` block:
  * @vuepress
  * ---
  * title: Your custom title
+ * headline: You custom headline
  * ---
  */
 ```
 
+Use `headline` to add a custom `h1` title.
+
 [More information](https://vuepress.vuejs.org/guide/markdown.html#front-matter)
 
 ## Example

diff --git a/cmds/index.js b/cmds/index.js
@@ -118,7 +118,7 @@ async function generate(argv) {
                   ]
                 });
               } catch (e) {
-                console.log(chalk.black.bgBlue('exlude by config'), `${folderPath}/${fileName}.md`);
+                console.log(chalk.black.bgBlue('exclude by config'), `${folderPath}/${fileName}.md`);
               }
             }
 
@@ -138,7 +138,15 @@ async function generate(argv) {
 
               fileContent += '\n---\n';
               if ((attributes && attributes.title) || !/\.vue$/.test(file)) {
-                fileContent += `\n# ${attributes && attributes.title ? attributes.title : fileName}\n\n`;
+                let headline = fileName;
+
+                if (attributes && attributes.headline) {
+                  headline = attributes.headline;
+                } else if (attributes && attributes.title) {
+                  headline = attributes.title;
+                }
+
+                fileContent += `\n# ${headline}\n\n`;
               }
               fileContent += mdFileData;
 

diff --git a/example/documentation/code/class.md b/example/documentation/code/class.md
@@ -1,9 +1,9 @@
 ---
-title: class.js
+title: class
 test: test class
 ---
 
-# class.js
+# class
 
 <a name="Test"></a>
 

diff --git a/example/documentation/code/config.js b/example/documentation/code/config.js
@@ -20,13 +20,12 @@ exports.fileTree = [
     ]
   },
   { name: 'test', path: '/test', fullPath: './documentation/code/test' },
-  { name: 'tests', children: [{ name: 'first.test', path: '/first.test', fullPath: 'tests/first.test' }] }
+  { name: 'tests', children: [] }
 ];
 exports.sidebarTree = (title = 'Mainpage') => ({
   '/code/': [
     { title: 'API', collapsable: false, children: [['', '' + title + ''], 'class', 'methods', 'objects', 'test'] },
     { title: 'lib', collapsable: false, children: ['lib/dmd-options', 'lib/jsdoc-to-markdown'] },
-    { title: 'subfolder', collapsable: false, children: ['subfolder/subfolder.1/variables', 'subfolder/variables'] },
-    { title: 'tests', collapsable: false, children: ['tests/first.test'] }
+    { title: 'subfolder', collapsable: false, children: ['subfolder/subfolder.1/variables', 'subfolder/variables'] }
   ]
 });
diff --git a/example/documentation/code/lib/dmd-options.md b/example/documentation/code/lib/dmd-options.md
@@ -1,8 +1,8 @@
 ---
-title: dmd-options.js
+title: dmd-options
 ---
 
-# dmd-options.js
+# dmd-options
 
 <a name="DmdOptions"></a>
 

diff --git a/example/documentation/code/lib/jsdoc-to-markdown.md b/example/documentation/code/lib/jsdoc-to-markdown.md
@@ -1,8 +1,8 @@
 ---
-title: jsdoc-to-markdown.js
+title: jsdoc-to-markdown
 ---
 
-# jsdoc-to-markdown.js
+# jsdoc-to-markdown
 
 <a name="module_jsdoc-to-markdown"></a>
 

diff --git a/example/documentation/code/methods.md b/example/documentation/code/methods.md
@@ -1,8 +1,9 @@
 ---
 title: A normal ES6 Method
+headline: Custom Title!
 ---
 
-# A normal ES6 Method
+# Custom Title!
 
 ## Functions
 

diff --git a/example/documentation/code/objects.md b/example/documentation/code/objects.md
@@ -1,8 +1,8 @@
 ---
-title: objects.js
+title: objects
 ---
 
-# objects.js
+# objects
 
 <a name="obj"></a>
 

diff --git a/example/documentation/code/subfolder/subfolder.1/variables.md b/example/documentation/code/subfolder/subfolder.1/variables.md
@@ -1,8 +1,8 @@
 ---
-title: variables.js
+title: variables
 ---
 
-# variables.js
+# variables
 
 ## Members
 

diff --git a/example/documentation/code/subfolder/variables.md b/example/documentation/code/subfolder/variables.md
@@ -1,8 +1,8 @@
 ---
-title: variables.js
+title: variables
 ---
 
-# variables.js
+# variables
 
 ## Members
 

diff --git a/example/documentation/code/test.md b/example/documentation/code/test.md
@@ -1,9 +1,6 @@
 ---
-title: test.vue
+title: test
 ---
-
-# test.vue
-
 # test 
 
 - **vue** 

diff --git a/example/documentation/code/tests/first.test.md b/example/documentation/code/tests/first.test.md
diff --git a/example/src/methods.js b/example/src/methods.js
@@ -2,6 +2,7 @@
  * @vuepress
  * ---
  * title: A normal ES6 Method
+ * headline: Custom Title!
  * ---
  */
 /**

diff --git a/package.json b/package.json
@@ -67,20 +67,20 @@
     "bluebird": "^3.5.3",
     "chalk": "^2.4.2",
     "cross-env": "^5.2.0",
-    "del": "^3.0.0",
+    "del": "^4.1.0",
     "front-matter": "^3.0.1",
     "fs.promised": "^3.0.0",
     "jsdoc-to-markdown": "^4.0.1",
     "micromatch": "^3.1.10",
     "mkdirp": "^0.5.1",
     "rimraf": "^2.6.3",
-    "yargs": "^13.2.1"
+    "yargs": "^13.2.2"
   },
   "devDependencies": {
     "conventional-changelog-cli": "^2.0.12",
     "eslint": "^5.14.1",
     "husky": "^1.3.1",
-    "jest": "^24.1.0",
+    "jest": "^24.6.0",
     "lint-staged": "^8.1.4"
   },
   "lint-staged": {