-
Notifications
You must be signed in to change notification settings - Fork 223
Directory Structure
Viljami Salminen edited this page Nov 4, 2017
·
11 revisions
Below is the design system’s basic structure. The system’s pieces are split into Tokens, Elements, Patterns and Templates as explained in the Terminology section.
There’s also Styles directory which includes generic functions, mixins and variables that you might need. Currently, there’s for example a set of functions that can create tints and shades out of colors defined in Tokens.
Static directory is meant for any static files like for example icons, fonts and similar.
Router maps Templates to the routes and lets vue-router know when and where to render them.
Finally, docs includes any custom content that is shown in the system documentation.
├─ src
│ ├─ tokens
│ ├─ elements
│ │ └─ icons
│ ├─ patterns
│ ├─ templates
│ │ ├─ Styleguide.vue
│ │ └─ Template 1,2,3…
│ ├─ styles
│ ├─ router
│ └─ App.vue
├─ docs
├─ config
├─ build
└─ static- 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,PatternsandTemplates. - 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.