Skip to content

Commit db4a36f

Browse files
committed
docs: update readme and add console output
1 parent f864002 commit db4a36f

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

.eslintrc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
},
1616
"rules": {
1717
"quotes": ["error", "single", { "allowTemplateLiterals": true }],
18-
"no-console": "off"
18+
"no-console": "off",
19+
"arrow-parens": ["error", "as-needed"]
1920
}
2021
}

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This npm package is a command line script, which scans your JavaScript, Vue or T
77

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

10-
## How to use?
10+
## How to
1111

1212
```bash
1313
yarn global add vuepress-jsdoc
@@ -68,7 +68,7 @@ vuepress dev ./documentation
6868
vuepress build ./documentation
6969
```
7070

71-
**Access it via:** http://localhost:8080/code/
71+
**Access it via:** [http://localhost:8080/code/](http://localhost:8080/code/)
7272

7373
Now you need the sidebar.
7474
Create a `.vuepress` folder inside the `documentation` folder and add the following `config.js`.
@@ -129,7 +129,7 @@ Simply add:
129129
*/
130130
```
131131

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

134134
## Example
135135

cmds/index.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ async function generate(argv) {
5959
console.log(`\n${chalk.black.bgYellow('found')} ${readmePath} and copies content to ${docsFolder}/README.md`);
6060
}
6161
} catch (e) {
62-
console.log();
62+
console.log(`${chalk.white.bgBlack('skipped')} copy README.md`);
6363
}
6464

6565
// Do nothing if README.md already exists

0 commit comments

Comments
 (0)