Skip to content
This repository was archived by the owner on Apr 1, 2019. It is now read-only.

Commit ebe6230

Browse files
author
Walker Leite
committed
update docs and meta
1 parent f3c804b commit ebe6230

File tree

8 files changed

+51
-27
lines changed

8 files changed

+51
-27
lines changed

meta.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
const fs = require('fs');
2+
3+
module.exports = {
4+
"prompts": {
5+
"name": {
6+
"type": "string",
7+
"required": true,
8+
"label": "Component name in kebab-case format",
9+
"default": "v-awesome-component"
10+
},
11+
"description": {
12+
"type": "string",
13+
"required": true,
14+
"label": "Project description",
15+
"default": "A Vue.js component"
16+
},
17+
"author": {
18+
"type": "string",
19+
"label": "Author"
20+
}
21+
},
22+
"complete": function(data, {logger}) {
23+
logger.log("To get started:\n\n{{^inPlace}}cd {{destDirName}}\n\n \
24+
{{/inPlace}}1. Install dependencies npm install\n2. Write your component \
25+
in src/Component.vue\n3. Write a demo in docs docs/Usage.md\n4. Access \
26+
demo and docs with npm run serve\n5. Build with npm run build\n6. Build \
27+
docs with npm run build:doc");
28+
const name = require(data.destDirName + '/package.json').name;
29+
console.log(this, data, name);
30+
fs.renameSync('src/Component.vue', 'src/' + name + '.vue');
31+
}
32+
};

meta.json

Lines changed: 0 additions & 21 deletions
This file was deleted.

template/docs/Usage.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

template/docs/UseCase1.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
You can put more examples!
2+
<{{ name }} text="Hello World!" @click="alert('clicked!')"></{{ name }}>
3+
4+
* Remember to update styleguide.config.js also

template/docs/UseCase2.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
You can put more examples!
2+
<{{ name }} text="Hello World!" @click="alert('clicked in two!')"></{{ name }}>
3+
4+
* Remember to update styleguide.config.js also

template/src/Component.vue

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<script>
66
/**
7-
* {{description}}
7+
* Component documentation
88
*/
99
export default {
1010
name: '{{ name }}',

template/src/Readme.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Put here the component usage demo
2+
3+
<{{ name }} text="Hello World!" @click="alert('clicked!')"></{{ name }}>

template/styleguide.config.js

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,13 @@ module.exports = {
1111
sections: [
1212
/* One item for every different demo or doc of the component */
1313
{
14-
name: 'usage',
15-
content: 'docs/Usage.md'
14+
name: 'Use Case 1',
15+
content: 'docs/UseCase1.md'
16+
},
17+
/* One item for every different demo or doc of the component */
18+
{
19+
name: 'Use Case 2',
20+
content: 'docs/UseCase2.md'
1621
}
1722
]
1823
},

0 commit comments

Comments
 (0)