Skip to content

Commit

Permalink
Add vue file support
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Aug 20, 2018
1 parent 97e06b7 commit 8ebdb5d
Show file tree
Hide file tree
Showing 8 changed files with 11,192 additions and 1,923 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![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 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).

## How to use?

Expand Down
11 changes: 7 additions & 4 deletions example/documentation/.vuepress/config.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
const { sidebarTree } = require('../code/config');

module.exports = {
dest: 'dist',
const config = {
locales: {
'/': {
title: 'vuepress-jsdoc',
Expand All @@ -21,8 +20,12 @@ module.exports = {
}
],
// Add the generated sidebar
sidebar: Object.assign({}, sidebarTree)
sidebar: {
...sidebarTree
}
}
}
}
};
};

module.exports = config;
8 changes: 7 additions & 1 deletion example/documentation/code/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,11 @@ exports.fileTree=[
"fullPath": "subfolder/variables"
}
]
},
{
"name": "test",
"path": "/test",
"fullPath": "./documentation/code/test"
}
];
exports.sidebarTree={
Expand All @@ -62,7 +67,8 @@ exports.sidebarTree={
],
"class",
"methods",
"objects"
"objects",
"test"
]
},
{
Expand Down
Loading

0 comments on commit 8ebdb5d

Please sign in to comment.