Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate .md in the same vue components folder #17

Closed
equinusocio opened this issue Jan 8, 2019 · 4 comments
Closed

Generate .md in the same vue components folder #17

equinusocio opened this issue Jan 8, 2019 · 4 comments

Comments

@equinusocio
Copy link

equinusocio commented Jan 8, 2019

Hi, is there a way to generate .md files beside the vue SFC components? I have this structure and i want to generate each md in the same component folder:

src/components
├── Button
│   ├── Button.story.js
│   └── Button.vue
├── Icon
│   ├── Icon.story.js
│   └── Icon.vue
├── Skeleton
│   ├── Skeleton.story.js
└── └── Skeleton.vue
@HcySunYang
Copy link
Member

In fact, I have realized the benefits of this scenario and it is planned for the future.

@equinusocio
Copy link
Author

equinusocio commented Jan 8, 2019

Do you think is something that can be done right now with outDir and markdownDir configurations? Maybe allowing globs and wildcards in both configurations may help. Something like this:

{
  "include": ["src/components/**/*.vue"],
  "outDir": "src",
  "markdownDir": "**/*",
  "genType": "markdown"
}

@HcySunYang
Copy link
Member

Yes, this is a good suggestion, but unfortunately, it is not supported now.

HcySunYang added a commit that referenced this issue Jan 13, 2019
@HcySunYang
Copy link
Member

You can install @vuese/cli@^2.0.0-beta.8 which supports this feature.

1、Remove the previous global installation:

yarn global remove vuese 

2、Install @vuese/cli:

yarn global add @vuese/cli@^2.0.0-beta.8

3、Run the following command:

vuese gen --genType="markdown" --markdownDir="*"

The first available version of 2.0 will be released soon, you can view the 2.x roadmap for more planning: https://github.com/vuese/roadmap

thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants