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

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

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
function header(docs, config, hasSubComponent, componentRelativePath) {
    const frontMatter = [];
    const fileNameRoot = componentRelativePath.split('/').pop()?.split('.').shift() || 'Component';
    if (docs.length === 1) {
        const [doc] = docs;
        const { displayName, tags } = doc;
        const { deprecated } = tags || {};
        if (!config.outFile && deprecated) {
            // to avoid having the squiggles in the left menu for deprecated items
            // use the frontmatter feature of vuepress
            frontMatter.push(`title: ${displayName}`);
        }
    }
    if (hasSubComponent) {
        // show more than one level on subcomponents
        frontMatter.push('sidebarDepth: 2');
    }
    return frontMatter.length
        ? `
---
${frontMatter.join('\n')}
---
${docs.length > 1 ? `# ${fileNameRoot}\n` : ''}
`
        : '';
}
exports.default = header;
//# sourceMappingURL=header.js.map