feat(title): add title to every page

Now the frontmatter title is used as the main title
Updated the example

#14

Author: ph1p

README.md

@@ -3,7 +3,7 @@
 [![Codacy Badge](https://api.codacy.com/project/badge/Grade/9ec565a85a134df2a0f6bdf905e438d4)](https://app.codacy.com/app/ph1p/vuepress-jsdoc?utm_source=github.com&utm_medium=referral&utm_content=ph1p/vuepress-jsdoc&utm_campaign=Badge_Grade_Settings)
 [![npm](https://img.shields.io/npm/v/vuepress-jsdoc.svg)](https://www.npmjs.com/package/vuepress-jsdoc)
 
-This npm package is a command line script, which scans your JavaScript, Vue or Typescript source code and generates markdown files for vuepress with the help of [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown).
+This npm package is a command line script, which scans your JavaScript, Vue or Typescript source code and generates markdown files for vuepress with the help of [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) and [vuedoc](https://gitlab.com/vuedoc/md).
 
 ![CLI ./example](/example/img/cli.gif)
 

cmds/index.js

@@ -123,14 +123,24 @@ async function generate(argv) {
             }
 
             if (mdFileData) {
-              const { frontmatter } = parseVuepressComment(fileData);
+              const { frontmatter, attributes } = parseVuepressComment(fileData);
 
               console.log(chalk.black.bgGreen('write file'), `${folderPath}/${fileName}.md`);
 
-              await fs.writeFile(
-                `${folderPath}/${fileName}.md`,
-                `---\n${frontmatter || `title: ${fileName}`}\n---\n${mdFileData}`
-              );
+              let fileContent = '---\n';
+
+              fileContent += !attributes || !attributes.title ? `title: ${file}` : '';
+
+              if (frontmatter) {
+                fileContent += !attributes || !attributes.title ? '\n' : '';
+                fileContent += `${frontmatter}`;
+              }
+
+              fileContent += '\n---\n';
+              fileContent += `\n# ${attributes && attributes.title ? attributes.title : file}\n\n`;
+              fileContent += mdFileData;
+
+              await fs.writeFile(`${folderPath}/${fileName}.md`, fileContent);
 
               tree.push({
                 name: fileName,

example/documentation/code/class.md

@@ -1,6 +1,10 @@
 ---
-title: test class
+title: class.js
+test: test class
 ---
+
+# class.js
+
 <a name="Test"></a>
 
 ## Test

example/documentation/code/config.js

@@ -20,12 +20,13 @@ exports.fileTree = [
     ]
   },
   { name: 'test', path: '/test', fullPath: './documentation/code/test' },
-  { name: 'tests', children: [] }
+  { name: 'tests', children: [{ name: 'first.test', path: '/first.test', fullPath: 'tests/first.test' }] }
 ];
 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: 'subfolder', collapsable: false, children: ['subfolder/subfolder.1/variables', 'subfolder/variables'] },
+    { title: 'tests', collapsable: false, children: ['tests/first.test'] }
   ]
 });

example/documentation/code/lib/dmd-options.md

@@ -1,6 +1,9 @@
 ---
-title: dmd-options
+title: dmd-options.js
 ---
+
+# dmd-options.js
+
 <a name="DmdOptions"></a>
 
 ## DmdOptions

example/documentation/code/lib/jsdoc-to-markdown.md

@@ -1,6 +1,9 @@
 ---
-title: jsdoc-to-markdown
+title: jsdoc-to-markdown.js
 ---
+
+# jsdoc-to-markdown.js
+
 <a name="module_jsdoc-to-markdown"></a>
 
 ## jsdoc-to-markdown

example/documentation/code/methods.md

@@ -1,6 +1,9 @@
 ---
 title: A normal ES6 Method
 ---
+
+# A normal ES6 Method
+
 ## Functions
 
 <dl>

example/documentation/code/objects.md

@@ -1,6 +1,9 @@
 ---
-title: objects
+title: objects.js
 ---
+
+# objects.js
+
 <a name="obj"></a>
 
 ## obj

example/documentation/code/subfolder/subfolder.1/variables.md

@@ -1,6 +1,9 @@
 ---
-title: variables
+title: variables.js
 ---
+
+# variables.js
+
 ## Members
 
 <dl>

example/documentation/code/subfolder/variables.md

@@ -1,6 +1,9 @@
 ---
-title: variables
+title: variables.js
 ---
+
+# variables.js
+
 ## Members
 
 <dl>

example/documentation/code/test.md

@@ -1,6 +1,9 @@
 ---
-title: test
+title: test.vue
 ---
+
+# test.vue
+
 # test 
 
 - **vue** 

example/documentation/code/tests/first.test.md

@@ -0,0 +1,15 @@
+---
+title: first.test.js
+---
+
+# first.test.js
+
+<a name="FirstTest"></a>
+
+## FirstTest
+**Kind**: global class  
+<a name="new_FirstTest_new"></a>
+
+### new FirstTest()
+This is the FirstTest class
+

example/src/class.js

@@ -1,7 +1,7 @@
 /*
  * @vuepress
  * ---
- * title: test class
+ * test: test class
  * ---
  */
 /**

helpers/comment-parser.js

@@ -20,7 +20,7 @@ module.exports = fileContent => {
     );
   } catch (e) {
     return {
-      fontmatter: null
+      frontmatter: null
     };
   }
 };

tests/comment-parser.test.js

@@ -26,9 +26,9 @@ describe('commentParser', () => {
 });
 
 describe('commentParser fail', () => {
-  const { fontmatter } = commentParser();
+  const { frontmatter } = commentParser();
 
   test('fontmatter should be null', () => {
-    expect(fontmatter).toBe(null);
+    expect(frontmatter).toBe(null);
   });
 });