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

Commit

Permalink
update meta and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Walker Leite committed Sep 20, 2017
1 parent 8a99a9f commit 174bc27
Show file tree
Hide file tree
Showing 4 changed files with 28 additions and 8 deletions.
30 changes: 25 additions & 5 deletions meta.js
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,31 @@ module.exports = {

logger.log("To get started:");
if (!data.inPlace) logger.log("cd " + data.destDirName);

const logFiles = {
component: path.relative(
data.destDirName,
path.resolve(data.destDirName, 'src', data.name, data.name + '.vue')
),
componentDoc: path.relative(
data.destDirName,
path.resolve(data.destDirName, 'src', data.name, data.name + '.md')
),
usage: path.relative(
data.destDirName,
path.resolve(data.destDirName, 'docs/*.md')
)
}
logger.log("1. Install dependencies: npm install");
logger.log("2. Write your component in src/Component.vue");
logger.log("3. Write a demo in docs docs/Usage.md");
logger.log("4. Access demo and docs with npm run serve");
logger.log("5. Build with: npm run build");
logger.log("6. Build docs with: npm run build:doc");
logger.log("2. Write your component in " + logFiles.component);
logger.log(
"3. Write the component doc in " +
logFiles.componentDoc +
' or in the component itself using jsdoc'
);
logger.log("4. Write the demo and usage instructions in " + logFiles.usage);
logger.log("5. Access demo and docs with npm run serve");
logger.log("6. Build with: npm run build");
logger.log("7. Build docs with: npm run build:doc");
}
};
2 changes: 1 addition & 1 deletion template/docs/Introduction.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
> {{ description }}, below are all components created under src
> {{ description }}, below are the docs of every component created under src
2 changes: 1 addition & 1 deletion template/docs/UseCase1.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Just a example contained in a single doc file
Just an example contained in a single doc file

<{{ name }} text="Hello World!" style="color: red;"></{{ name }}>
2 changes: 1 addition & 1 deletion template/src/Component/Component.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
Put here the general component usage instructions
Put here the {{ name }} component usage instructions

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

0 comments on commit 174bc27

Please sign in to comment.