Skip to content

Commit

Permalink
docs: update readme and add console output
Browse files Browse the repository at this point in the history
  • Loading branch information
ph1p committed Feb 18, 2019
1 parent f864002 commit db4a36f
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 5 deletions.
3 changes: 2 additions & 1 deletion .eslintrc
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
},
"rules": {
"quotes": ["error", "single", { "allowTemplateLiterals": true }],
"no-console": "off"
"no-console": "off",
"arrow-parens": ["error", "as-needed"]
}
}
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ This npm package is a command line script, which scans your JavaScript, Vue or T

![CLI ./example](/example/img/cli.gif)

## How to use?
## How to

```bash
yarn global add vuepress-jsdoc
Expand Down Expand Up @@ -68,7 +68,7 @@ vuepress dev ./documentation
vuepress build ./documentation
```

**Access it via:** http://localhost:8080/code/
**Access it via:** [http://localhost:8080/code/](http://localhost:8080/code/)

Now you need the sidebar.
Create a `.vuepress` folder inside the `documentation` folder and add the following `config.js`.
Expand Down Expand Up @@ -129,7 +129,7 @@ Simply add:
*/
```

More information: https://vuepress.vuejs.org/guide/markdown.html#front-matter
[More information](https://vuepress.vuejs.org/guide/markdown.html#front-matter)

## Example

Expand Down
2 changes: 1 addition & 1 deletion cmds/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ async function generate(argv) {
console.log(`\n${chalk.black.bgYellow('found')} ${readmePath} and copies content to ${docsFolder}/README.md`);
}
} catch (e) {
console.log();
console.log(`${chalk.white.bgBlack('skipped')} copy README.md`);
}

// Do nothing if README.md already exists
Expand Down

0 comments on commit db4a36f

Please sign in to comment.