vue-docgen-cli/lib/templates/component.js

Generate documentation markdown files from VueJs components using the vue-docgen-api.

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.default = (renderedUsage, doc, config, fileName, requiresMd, { isSubComponent, hasSubComponents }) => {
    const { displayName, description, docsBlocks, tags, functional } = doc;
    const { deprecated, author, since, version, see, link } = tags || {};
    return `
  ${isSubComponent || hasSubComponents ? '#' : ''}# ${deprecated ? `~~${displayName}~~` : displayName}

  ${deprecated ? `> **Deprecated** ${deprecated[0].description}\n` : ''}
  ${description ? '> ' + description : ''}

  ${functional ? renderedUsage.functionalTag : ''}
  ${author ? author.map(a => `Author: ${a.description}\n`) : ''}
  ${since ? `Since: ${since[0].description}\n` : ''}
  ${version ? `Version: ${version[0].description}\n` : ''}
  ${see ? see.map(s => `[See](${s.description})\n`) : ''}
  ${link ? link.map(l => `[See](${l.description})\n`) : ''}

  ${renderedUsage.props}
  ${renderedUsage.methods}
  ${renderedUsage.events}
  ${renderedUsage.slots}
  ${renderedUsage.expose}
  ${docsBlocks ? '---\n' + docsBlocks.join('\n---\n') : ''}

  ${requiresMd.length
        ? '---\n' + requiresMd.map(component => component.content).join('\n---\n')
        : ''}
  `;
};
//# sourceMappingURL=component.js.map