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.

Sign up for GitHub

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

Jump to bottom

Markdown in additional vue tags don't work. #406

Open

scheepers opened this issue Feb 8, 2021 · 0 comments

scheepers commented Feb 8, 2021

Behaviour: Outputs markdown as is.

Expected: Parse markdown (eg links) and render into HTML in the docs.

To replicate:

Specify additional tags to process markdown in a config.json as per https://jsdoc.app/plugins-markdown.html:

{
 "source": {
    "include": ["./src/components"],
    "includePattern": ".+\\.(vue|js)$"
  },

  "plugins": [
    "node_modules/jsdoc-vuejs",
    "node_modules/jsdoc/plugins/markdown"
  ],

  "markdown": {
    "tags": ["vue-prop"]
  }
}

Add markdown to an additional prop:

/**
   * @vue-prop {boolean} [dense='false'] [vue-tel-input-vuetify dense, filled and outlined props](https://www.npmjs.com/package/vue-tel-input-vuetify#props)
   */

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