#977 Docs: add the customization guide

Merged Barthélémy Ledoux elevatebart Pseudo commit used to compare (43cc772...1295795)
Coverage Reach
vue-docgen-api/src/script-handlers/propHandler.ts vue-docgen-api/src/script-handlers/slotHandler.ts vue-docgen-api/src/script-handlers/eventHandler.ts vue-docgen-api/src/script-handlers/methodHandler.ts vue-docgen-api/src/script-handlers/utils/parseValidator.ts vue-docgen-api/src/script-handlers/utils/getProperties.ts vue-docgen-api/src/script-handlers/classPropHandler.ts vue-docgen-api/src/script-handlers/slotHandlerFunctional.ts vue-docgen-api/src/script-handlers/componentHandler.ts vue-docgen-api/src/script-handlers/classEventHandler.ts vue-docgen-api/src/script-handlers/mixinsHandler.ts vue-docgen-api/src/script-handlers/displayNameHandler.ts vue-docgen-api/src/script-handlers/extendsHandler.ts vue-docgen-api/src/script-handlers/index.ts vue-docgen-api/src/script-handlers/classMethodHandler.ts vue-docgen-api/src/script-handlers/slotHandlerLitteral.ts vue-docgen-api/src/script-handlers/classDisplayNameHandler.ts vue-docgen-api/src/utils/resolveExportedComponent.ts vue-docgen-api/src/utils/resolveImmediatelyExported.ts vue-docgen-api/src/utils/resolveRequired.ts vue-docgen-api/src/utils/documentRequiredComponents.ts vue-docgen-api/src/utils/recursiveResolveIEV.ts vue-docgen-api/src/utils/getDoclets.ts vue-docgen-api/src/utils/getTypeFromAnnotation.ts vue-docgen-api/src/utils/resolvePathFrom.ts vue-docgen-api/src/utils/resolveIdentifier.ts vue-docgen-api/src/utils/resolveExportDeclaration.ts vue-docgen-api/src/utils/matchRecursiveRegexp.ts vue-docgen-api/src/utils/isExportedAssignment.ts vue-docgen-api/src/utils/getDocblock.ts vue-docgen-api/src/utils/extractLeadingComment.ts vue-docgen-api/src/utils/guards.ts vue-docgen-api/src/utils/resolveAliases.ts vue-docgen-api/src/utils/transformTagsIntoObject.ts vue-docgen-api/src/utils/cacher.ts vue-docgen-api/src/utils/getArgFromDecorator.ts vue-docgen-api/src/utils/getPropsFilter.ts vue-docgen-api/src/utils/makePathResolver.ts vue-docgen-api/src/utils/getTemplateExpressionAST.ts vue-docgen-api/src/utils/missing-files-cache.ts vue-docgen-api/src/template-handlers/slotHandler.ts vue-docgen-api/src/template-handlers/propHandler.ts vue-docgen-api/src/template-handlers/eventHandler.ts vue-docgen-api/src/template-handlers/index.ts vue-docgen-api/src/parseSFC.ts vue-docgen-api/src/Documentation.ts vue-docgen-api/src/parse-script.ts vue-docgen-api/src/parse.ts vue-docgen-api/src/main.ts vue-docgen-api/src/parse-template.ts vue-docgen-api/src/babel-parser.ts vue-styleguidist/src/client/rsg-components/Preview/PreviewAsync.js vue-styleguidist/src/client/rsg-components/Preview/Preview.js vue-styleguidist/src/client/rsg-components/VsgEditor/EditorPrism.tsx vue-styleguidist/src/client/rsg-components/VsgEditor/Editor.js vue-styleguidist/src/client/rsg-components/Argument/ArgumentRenderer.tsx vue-styleguidist/src/client/rsg-components/Argument/Argument.spec.tsx vue-styleguidist/src/client/rsg-components/Argument/index.ts vue-styleguidist/src/client/rsg-components/Props/PropsRenderer.js vue-styleguidist/src/client/rsg-components/Props/renderDefault.js vue-styleguidist/src/client/rsg-components/Props/util.js vue-styleguidist/src/client/rsg-components/Props/renderType.js vue-styleguidist/src/client/rsg-components/SectionHeading/SectionHeadingRenderer.tsx vue-styleguidist/src/client/rsg-components/SectionHeading/SectionHeading.tsx vue-styleguidist/src/client/rsg-components/SectionHeading/index.ts vue-styleguidist/src/client/rsg-components/slots/UsageTabButton.tsx vue-styleguidist/src/client/rsg-components/slots/IsolateButton.tsx vue-styleguidist/src/client/rsg-components/slots/index.ts vue-styleguidist/src/client/rsg-components/slots/CodeTabButton.tsx vue-styleguidist/src/client/rsg-components/VsgArgument/ArgumentRenderer.tsx vue-styleguidist/src/client/rsg-components/VsgArgument/index.ts vue-styleguidist/src/client/rsg-components/Arguments/ArgumentsRenderer.tsx vue-styleguidist/src/client/rsg-components/Arguments/Arguments.spec.tsx vue-styleguidist/src/client/rsg-components/Arguments/index.ts vue-styleguidist/src/client/rsg-components/JsDoc/JsDoc.tsx vue-styleguidist/src/client/rsg-components/JsDoc/index.ts vue-styleguidist/src/client/rsg-components/VsgReactComponent/ReactComponent.tsx vue-styleguidist/src/client/rsg-components/Events/EventsRenderer.js vue-styleguidist/src/client/rsg-components/Methods/MethodsRenderer.tsx vue-styleguidist/src/client/rsg-components/Methods/index.ts vue-styleguidist/src/client/rsg-components/ExamplePlaceholder/ExamplePlaceholderRenderer.js vue-styleguidist/src/client/rsg-components/Usage/Usage.spec.js vue-styleguidist/src/client/rsg-components/Usage/Usage.js vue-styleguidist/src/client/rsg-components/SlotsTable/SlotsTableRenderer.js vue-styleguidist/src/client/rsg-components/SubComponents/SubComponents.tsx vue-styleguidist/src/client/rsg-components/SubComponents/index.ts vue-styleguidist/src/client/rsg-components/StyleguideFooter/StyleguideFooterRenderer.tsx vue-styleguidist/src/client/rsg-components/StyleguideFooter/index.ts vue-styleguidist/src/client/rsg-components/PlaygroundAsync/PlaygroundAsync.js vue-styleguidist/src/client/rsg-components/OriginColumn/OriginColumn.tsx vue-styleguidist/src/client/rsg-components/OriginColumn/index.ts vue-styleguidist/src/client/rsg-components/Welcome/WelcomeRenderer.js vue-styleguidist/src/client/rsg-components/Welcome/Welcome.spec.js vue-styleguidist/src/client/rsg-components/VsgStyleGuide/StyleGuideRenderer.js vue-styleguidist/src/client/rsg-components/Table/TableRenderer.js vue-styleguidist/src/client/rsg-components/EditorWithToolbar/EditorWithToolbar.js vue-styleguidist/src/client/rsg-components/EditorAsync/EditorAsync.js vue-styleguidist/src/client/rsg-components/EditorPrecompiled/EditorPrecompiled.js vue-styleguidist/src/client/utils/renderStyleguide.tsx vue-styleguidist/src/client/utils/processComponents.ts vue-styleguidist/src/client/utils/processSections.ts vue-styleguidist/src/client/utils/renderTypeString.ts vue-styleguidist/src/client/utils/globalizeComponent.ts vue-styleguidist/src/client/utils/getComponentsFromSections.ts vue-styleguidist/src/client/utils/compileExamples.ts vue-styleguidist/src/client/utils/utils.ts vue-styleguidist/src/client/utils/propStyles.ts vue-styleguidist/src/client/index.ts vue-styleguidist/src/loaders/utils/getSections.ts vue-styleguidist/src/loaders/utils/getParser.ts vue-styleguidist/src/loaders/utils/processComponent.ts vue-styleguidist/src/loaders/utils/getExamples.ts vue-styleguidist/src/loaders/utils/importCodeExampleFile.ts vue-styleguidist/src/loaders/utils/getComponentVueDoc.ts vue-styleguidist/src/loaders/utils/findOrigins.ts vue-styleguidist/src/loaders/utils/parseVue.ts vue-styleguidist/src/loaders/utils/stripOutOrigins.ts vue-styleguidist/src/loaders/utils/getScript.ts vue-styleguidist/src/loaders/utils/client/requireInRuntime.js vue-styleguidist/src/loaders/utils/client/evalInContext.js vue-styleguidist/src/loaders/utils/expandDefaultComponent.ts vue-styleguidist/src/loaders/utils/getComponents.ts vue-styleguidist/src/loaders/utils/absolutize.ts vue-styleguidist/src/loaders/utils/already-loaded-examples-cache.ts vue-styleguidist/src/loaders/examples-loader.ts vue-styleguidist/src/loaders/vuedoc-loader.ts vue-styleguidist/src/loaders/styleguide-loader.ts vue-styleguidist/src/loaders/docs-loader.ts vue-styleguidist/src/loaders/style-loader.ts vue-styleguidist/src/loaders/css-loader.ts vue-styleguidist/src/scripts/binutils.ts vue-styleguidist/src/scripts/make-webpack-config.ts vue-styleguidist/src/scripts/schemas/config.ts vue-styleguidist/src/scripts/config.ts vue-styleguidist/src/scripts/index.ts vue-styleguidist/src/scripts/utils/mergeWebpackConfig.ts vue-styleguidist/src/scripts/utils/findUserWebpackConfig.ts vue-styleguidist/src/scripts/utils/isPromise.ts vue-styleguidist/src/scripts/create-server.ts vue-styleguidist/src/scripts/server.ts vue-styleguidist/src/scripts/build.ts vue-styleguidist/src/scripts/consts.ts vue-styleguidist/src/bin/styleguidist.ts vue-styleguidist/src/types/Component.ts vue-docgen-cli/src/templates/methods.ts vue-docgen-cli/src/templates/component.ts vue-docgen-cli/src/templates/utils.ts vue-docgen-cli/src/templates/props.ts vue-docgen-cli/src/templates/events.ts vue-docgen-cli/src/templates/slots.ts vue-docgen-cli/src/templates/defaultExample.ts vue-docgen-cli/src/templates/functionalTag.ts vue-docgen-cli/src/compileTemplates.ts vue-docgen-cli/src/getDocsBlocks.ts vue-docgen-cli/src/utils.ts vue-docgen-cli/src/extractConfig.ts vue-docgen-cli/src/multiMd.ts vue-docgen-cli/src/singleMd.ts vue-docgen-cli/src/getSources.ts vue-docgen-cli/src/docgen.ts vue-docgen-cli/src/bin.ts vue-inbrowser-compiler-utils/src/adaptCreateElement.ts vue-inbrowser-compiler-utils/src/getDefaultExample.ts vue-inbrowser-compiler-utils/src/parseComponent.ts vue-inbrowser-compiler-utils/src/styleScoper.ts vue-inbrowser-compiler-utils/src/addScopedStyle.ts vue-inbrowser-compiler-utils/src/index.ts vue-inbrowser-compiler-utils/src/isCodeVueSfc.ts vue-inbrowser-compiler-utils/src/cleanName.ts vue-inbrowser-compiler/src/normalizeSfcComponent.ts vue-inbrowser-compiler/src/compileVueCodeForEvalFunction.ts vue-inbrowser-compiler/src/rewriteImports.ts vue-inbrowser-compiler/src/transformOneImport.ts vue-inbrowser-compiler/src/index.ts vue-inbrowser-compiler/src/getAst.ts

No flags found

Use flags to group coverage reports by test type, project and/or folders.
Then setup custom commit statuses and notifications for each flag.

e.g., #unittest #integration

#production #enterprise

#frontend #backend

Learn more about Codecov Flags here.

Learn more Showing 1 files with coverage changes found.

Changes in packages/vue-styleguidist/src/client/index.ts
+1
Loading file...
Files Coverage
packages 0.15% 63.96%
Project Totals (175 files) 63.96%
Loading