@copiedcode/design-system
v1.2.0
Published
A SCSS library encapsulating common styles and design paradigms.
Downloads
6
Maintainers
Readme
CopiedCode LLC - Design System
A SCSS library encapsulating common styles and design paradigms.
Quick Start
- Install the design system into your project.
- If using npm:
npm i @copiedcode/design-system
- If using yarn:
yarn add @copiedcode/design-system
- If using npm:
- Create a configuration file
.ccdesignrc
in your project. - Run the script
npx ccdesign
to override SCSS defaults with your config.
Auto Documentation
This project is documented with the SassDoc tool - a documentation system to build pretty and powerful docs.
Usage
To generate documentation, run the script yarn document
and open the index.html
file generated under the docs
directory.
Examples
Documentation comments are silent comments, written with three slashes (///) directly above the thing you’re documenting. SassDoc parses text in the comments as Markdown, and supports many useful annotations to describe it in detail.
TODO - include documentation snippets
Linting
Code formatting for this project is strictly enforced by the configuration defined for Stylelint.
Usage
To lint the project, run the script yarn lint
followed by any desired options as flags.
Any changes to linting rules can be made in the .stylelintrc
file in the root directory.
Transpilation
TODO - document transpilation stage