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

Commit 174bc27

Browse files
author
Walker Leite
committed
update meta and docs
1 parent 8a99a9f commit 174bc27

File tree

4 files changed

+28
-8
lines changed

4 files changed

+28
-8
lines changed

meta.js

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,31 @@ module.exports = {
3838

3939
logger.log("To get started:");
4040
if (!data.inPlace) logger.log("cd " + data.destDirName);
41+
42+
const logFiles = {
43+
component: path.relative(
44+
data.destDirName,
45+
path.resolve(data.destDirName, 'src', data.name, data.name + '.vue')
46+
),
47+
componentDoc: path.relative(
48+
data.destDirName,
49+
path.resolve(data.destDirName, 'src', data.name, data.name + '.md')
50+
),
51+
usage: path.relative(
52+
data.destDirName,
53+
path.resolve(data.destDirName, 'docs/*.md')
54+
)
55+
}
4156
logger.log("1. Install dependencies: npm install");
42-
logger.log("2. Write your component in src/Component.vue");
43-
logger.log("3. Write a demo in docs docs/Usage.md");
44-
logger.log("4. Access demo and docs with npm run serve");
45-
logger.log("5. Build with: npm run build");
46-
logger.log("6. Build docs with: npm run build:doc");
57+
logger.log("2. Write your component in " + logFiles.component);
58+
logger.log(
59+
"3. Write the component doc in " +
60+
logFiles.componentDoc +
61+
' or in the component itself using jsdoc'
62+
);
63+
logger.log("4. Write the demo and usage instructions in " + logFiles.usage);
64+
logger.log("5. Access demo and docs with npm run serve");
65+
logger.log("6. Build with: npm run build");
66+
logger.log("7. Build docs with: npm run build:doc");
4767
}
4868
};

template/docs/Introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
> {{ description }}, below are all components created under src
1+
> {{ description }}, below are the docs of every component created under src

template/docs/UseCase1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Just a example contained in a single doc file
1+
Just an example contained in a single doc file
22

33
<{{ name }} text="Hello World!" style="color: red;"></{{ name }}>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
Put here the general component usage instructions
1+
Put here the {{ name }} component usage instructions
22

33
<{{ name }} text="Hello World!"></{{ name }}>

0 commit comments

Comments
 (0)