atlas-design/css
Ming Ho d1e60821f6 Add border light 2024-11-11 11:16:09 -08:00
..
class-names
src Add border light 2024-11-11 11:16:09 -08:00
tokens
.npmignore
.parcelrc
.stylelintrc.json
CHANGELOG.md Version Packages (#691) 2024-10-04 14:07:05 -07:00
README.md readme badge size (#594) 2024-07-17 11:17:07 -07:00
jsconfig.json
package.json Version Packages (#691) 2024-10-04 14:07:05 -07:00

README.md

Atlas CSS

Welcome to the Atlas CSS framework, the code backing the Atlas design system. This framework is built and maintained by the Developer Relations web team for use across Microsoft.

Use atlas-css on Code Pen

Using CodePen as a sandbox, you can try out the framework.

Installation

Use NPM to add @microsoft/atlas-css to your project.

# install with NPM
npm install --save @microsoft/atlas-css

Alternatively, you may access our scss directly for prototyping purposes at the following url:

https://unpkg.com/@microsoft/atlas-css/dist/index.css

Project Structure

Each folder has an index file and a README that explains the nature of the folder. Each folder contains an index.scss file that imports all files within that folder. All folders can be imported at once via the top-level index.scss file.

css
└───src
    ├───tokens/
    ├───mixins/
    ├───core/
    ├───atomics/
    └───components/

Tokens

The tokens folder is the place where we define variables for use. This folder produces no output when included by itself. It's primary purpose is to provide a central place to define shared values used across the framework.

All variable declarations in the tokens folder make use of the !default flag, so you can override them by defining your own values before importing atlas-css.