CARVIEW |
Select Language
HTTP/2 200
date: Thu, 17 Jul 2025 19:44:34 GMT
content-type: text/html; charset=utf-8
vary: X-PJAX, X-PJAX-Container, Turbo-Visit, Turbo-Frame, X-Requested-With,Accept-Encoding, Accept, X-Requested-With
etag: W/"431221f4bfbae5e10a31aa0bf2d6bbcf"
cache-control: max-age=0, private, must-revalidate
strict-transport-security: max-age=31536000; includeSubdomains; preload
x-frame-options: deny
x-content-type-options: nosniff
x-xss-protection: 0
referrer-policy: no-referrer-when-downgrade
content-security-policy: default-src 'none'; base-uri 'self'; child-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/; connect-src 'self' uploads.github.com www.githubstatus.com collector.github.com raw.githubusercontent.com api.github.com github-cloud.s3.amazonaws.com github-production-repository-file-5c1aeb.s3.amazonaws.com github-production-upload-manifest-file-7fdce7.s3.amazonaws.com github-production-user-asset-6210df.s3.amazonaws.com *.rel.tunnels.api.visualstudio.com wss://*.rel.tunnels.api.visualstudio.com objects-origin.githubusercontent.com copilot-proxy.githubusercontent.com proxy.individual.githubcopilot.com proxy.business.githubcopilot.com proxy.enterprise.githubcopilot.com *.actions.githubusercontent.com wss://*.actions.githubusercontent.com productionresultssa0.blob.core.windows.net/ productionresultssa1.blob.core.windows.net/ productionresultssa2.blob.core.windows.net/ productionresultssa3.blob.core.windows.net/ productionresultssa4.blob.core.windows.net/ productionresultssa5.blob.core.windows.net/ productionresultssa6.blob.core.windows.net/ productionresultssa7.blob.core.windows.net/ productionresultssa8.blob.core.windows.net/ productionresultssa9.blob.core.windows.net/ productionresultssa10.blob.core.windows.net/ productionresultssa11.blob.core.windows.net/ productionresultssa12.blob.core.windows.net/ productionresultssa13.blob.core.windows.net/ productionresultssa14.blob.core.windows.net/ productionresultssa15.blob.core.windows.net/ productionresultssa16.blob.core.windows.net/ productionresultssa17.blob.core.windows.net/ productionresultssa18.blob.core.windows.net/ productionresultssa19.blob.core.windows.net/ github-production-repository-image-32fea6.s3.amazonaws.com github-production-release-asset-2e65be.s3.amazonaws.com insights.github.com wss://alive.github.com api.githubcopilot.com api.individual.githubcopilot.com api.business.githubcopilot.com api.enterprise.githubcopilot.com; font-src github.githubassets.com; form-action 'self' github.com gist.github.com copilot-workspace.githubnext.com objects-origin.githubusercontent.com; frame-ancestors 'none'; frame-src viewscreen.githubusercontent.com notebooks.githubusercontent.com; img-src 'self' data: blob: github.githubassets.com media.githubusercontent.com camo.githubusercontent.com identicons.github.com avatars.githubusercontent.com private-avatars.githubusercontent.com github-cloud.s3.amazonaws.com objects.githubusercontent.com release-assets.githubusercontent.com secured-user-images.githubusercontent.com/ user-images.githubusercontent.com/ private-user-images.githubusercontent.com opengraph.githubassets.com copilotprodattachments.blob.core.windows.net/github-production-copilot-attachments/ github-production-user-asset-6210df.s3.amazonaws.com customer-stories-feed.github.com spotlights-feed.github.com objects-origin.githubusercontent.com *.githubusercontent.com; manifest-src 'self'; media-src github.com user-images.githubusercontent.com/ secured-user-images.githubusercontent.com/ private-user-images.githubusercontent.com github-production-user-asset-6210df.s3.amazonaws.com gist.github.com; script-src github.githubassets.com; style-src 'unsafe-inline' github.githubassets.com; upgrade-insecure-requests; worker-src github.githubassets.com github.com/assets-cdn/worker/ github.com/assets/ gist.github.com/assets-cdn/worker/
server: github.com
content-encoding: gzip
accept-ranges: bytes
set-cookie: _gh_sess=wvxtkrIFV1CCe%2Bvtp%2FLDrST7XbX4KBZAniX3IE3EiLAA5mxVYkhWPGcKYdY4WokUeoX06XWmN2EO%2B%2BIMWrZs%2BWAKH2yI2XqylOV2c0lBIcpAxpOdWCvOsAqyY6EgLAnuqg1RARHb2YpmBdoZOO24ZvEe%2BH8KO0HAec1VvQEcjIqxHf7teJ%2Fzy66BXSy1N7Ag%2By%2FdA3i4E7k%2FrZKhyuBDsXka0uN2tC5JOkuozcUuQfLDQylRHL9ebBAbOLI3wfFzKOPcc5HkSEBnbgmQ6AWiUw%3D%3D--ULF2VtkfONkXtArQ--hiCj5Ux1jklgeaSP4nF3Pw%3D%3D; Path=/; HttpOnly; Secure; SameSite=Lax
set-cookie: _octo=GH1.1.1937867286.1752781473; Path=/; Domain=github.com; Expires=Fri, 17 Jul 2026 19:44:33 GMT; Secure; SameSite=Lax
set-cookie: logged_in=no; Path=/; Domain=github.com; Expires=Fri, 17 Jul 2026 19:44:33 GMT; HttpOnly; Secure; SameSite=Lax
x-github-request-id: A1F8:3FB647:4ADD8A:5883A6:687952A1
Editing Living Documentation · arielsalminen/vue-design-system Wiki · GitHub
Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 222
Editing Living Documentation
Ariel Salminen edited this page Jan 17, 2025
·
5 revisions
System’s components are documented based on the comments in your source code and readme files that live inside /docs/
. Each Element
, Pattern
and Template
can also include a custom block called <docs/>
, which is used to provide an example of the markup. Like this:
<docs>
```jsx
<wrapper>I’m an example that will be shown in docs.</wrapper>
```
</docs>
In addition, you can include JSDoc style comment blocks inside your <script/>
which will be shown in the documentation. An example:
<script>
/**
* A wrapper element is used to wrap elements and patterns.
*/
export default {
name: "Wrapper",
status: "prototype",
version: "1.0.0",
props: {
/**
* The html element name used for the wrapper.
*/
type: {
type: String,
default: "div"
}
}
}
</script>
Finally, the wrapper Element
with all the documentation added:
<template>
<component :is="type" class="wrapper">
<slot/>
</component>
</template>
<script>
/**
* A wrapper element is used to wrap elements and patterns.
*/
export default {
name: "Wrapper",
status: "prototype",
version: "1.0.0",
props: {
/**
* The html element name used for the wrapper.
*/
type: {
type: String,
default: "div"
}
}
}
</script>
<style lang="scss" scoped>
.wrapper {
@include reset;
@include inset-space($space-large);
width: 100%;
}
</style>
<docs>
```jsx
<wrapper>I’m an example that will be shown in docs.</wrapper>
```
</docs>
To learn more about the documentation format and what you can do with it, Please refer to Vue Styleguidist’s official docs on GitHub.
- Getting Started: How to install and run Vue Design System.
- Terminology: Introduction to the system concepts and its hierarchy.
- Naming of Things: Naming is hard, so it’s good to have clear guidelines.
- Directory Structure: What goes where and why.
-
Working with the System: Concrete examples on how to work with
Tokens
,Elements
,Patterns
andTemplates
. - Editing Living Documentation: How to customize the living system documentation.
- Spacing: A framework for creating a predictable and harmonious spacing.
- Component Status: Clear labels that reflect the state of completion.
- Component QA: How to review new components and keep the quality high.
- Contributing: A set of guidelines for contributing to the system.
- Code of Conduct: By participating you agree to abide by its terms.
- Frequently Asked Questions: How to use icons, how to use font-face, etc.
- Changelog: See releases pafge for the full changelog.
You can’t perform that action at this time.