@vuedoc/md/lib/config.schema.js

Generate a Markdown Documentation for a Vue file component

/* eslint-disable max-len */

import VuedocParserSchema from '@vuedoc/parser/schema/options';

export default {
  type: 'object',
  properties: {
    join: {
      type: 'boolean',
      default: false,
      description: 'Combine generated documentation for multiple component files into only one',
    },
    output: {
      type: 'string',
      minLength: 1,
      description: 'The output of the documentation. Can be a directory or a Markdown file. If absent, the STDOUT will be used',
    },
    section: {
      type: 'string',
      minLength: 1,
      description: 'Inject the generated documentation to a section. Works with options.output as Markdown file output',
    },
    level: {
      type: 'number',
      minimum: 1,
      description: 'Set the title level. An integer between 1 and 6',
    },
    wordwrap: {
      type: 'number',
      minimum: 0,
      default: 80,
      description: 'The width of the text before wrapping to a new line. Set to `0` to disable word wrapping',
    },
    filenames: {
      type: 'array',
      items: {
        type: 'string',
        minLength: 1,
      },
      description: 'List of component filenames to parse and render. If `options.join === true` options.filenames will be rendered as a single component',
      default: [],
    },
    parsing: VuedocParserSchema,
  },
  additionalProperties: false,
};