Skip to content

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

@scheepers

Description

@scheepers

Behaviour: Outputs markdown as is.
Screenshot 2021-02-08 at 19 38 36

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)
   */

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions