@stackoverflow/stacks
Advanced tools
Comparing version 0.24.1 to 0.25.0
@@ -8,3 +8,3 @@ { | ||
}, | ||
"version": "0.24.1", | ||
"version": "0.25.0", | ||
"unpkg": "lib/css/stacks.min.css", | ||
@@ -11,0 +11,0 @@ "scripts": { |
# Stacks | ||
Stacks is Stack Overflow’s design system. It includes the resources needed to create consistent, predictable workflows and interfaces that adhere with Stack Overflow’s principles, design language, and best practices. It’s built using [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components for rapidly prototyping, building, and styling. The Stacks website documents a range of resources, including: | ||
Stacks is Stack Overflow’s design system. It includes the resources needed to create consistent, predictable interfaces and workflows that conform to Stack Overflow’s principles, design language, and best practices. | ||
- Semantic and accessible component markup | ||
- Cross-browser compatible Less / CSS | ||
- An icon library | ||
Our documentation is built with Stacks itself, using its [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components. | ||
The Stacks website documents: | ||
### Product | ||
- Semantic and accessible component markup | ||
- Cross-browser compatible Less / CSS | ||
- An [icon library](https://github.com/StackExchange/Stacks-Icons) | ||
- Email templates & components | ||
Stacks documentation can be found at https://stackoverflow.design/ | ||
## Table of contents | ||
- [Using Stacks](#using-stacks) | ||
- [Getting setup](#getting-setup) | ||
- [What's included](#whats-included) | ||
- [Bugs and feature requests](#bugs-and-feature-requests) | ||
- [Contributing](#contributing) | ||
- [Team](#team) | ||
- [License](#license) | ||
- [Using Stacks](#using-stacks) | ||
- [Getting setup](#getting-setup) | ||
- [What's included](#whats-included) | ||
- [Bugs and feature requests](#bugs-and-feature-requests) | ||
- [Contributing](#contributing) | ||
- [Team](#team) | ||
- [License](#license) | ||
## Using Stacks | ||
@@ -27,8 +33,8 @@ | ||
1. Stacks is currently included within various Stack Overflow projects automatically. If you’re working on a Stack Overflow project, chances are it’s already available for you! If not, reach out to use and we’ll work on getting it setup. | ||
2. To include it in other projects, you can intall it via [NPM](https://www.npmjs.com/package/@stackoverflow/stacks): | ||
1. Stacks is currently included within various Stack Overflow projects automatically. If you’re working on a Stack Overflow project, chances are it’s already available for you! If not, reach out to use and we’ll work on getting it setup. | ||
2. To include it in other projects, you can install it via [NPM](https://www.npmjs.com/package/@stackoverflow/stacks): | ||
```bash | ||
npm install --save @stackoverflow/stacks | ||
``` | ||
3. You can also include a minified, compiled Stacks CSS style sheet: | ||
3. You can also include a minified, compiled Stacks CSS style sheet. This is good for things like Codepen or other quick prototypes: | ||
```html | ||
@@ -40,53 +46,6 @@ <link rel="stylesheet" href="https://unpkg.com/@stackoverflow/stacks"> | ||
1. Our documentation site uses the Jekyll static site generator. You will need to install that and its various dependencies first. To install, [follow this guide from CloudCannon.com](https://learn.cloudcannon.com/jekyll/install-jekyll-on-os-x/). | ||
2. We use the task runner Grunt to compile our Less, rebuild the documentation site, minify things, auto-prefix things, and other tasks. To install and run Grunt and its various dependencies, you’ll first need to install [Node & NPM](https://nodejs.org/en/download/). | ||
3. Clone the project | ||
```bash | ||
# Clone your fork of the repo into the current directory | ||
git clone https://github.com/StackExchange/Stacks.git | ||
# Navigate to the newly cloned directory | ||
cd Stacks | ||
``` | ||
4. Run `npm install`. This will install all the required project dependencies for Grunt. | ||
3. Run `npm start`. This will run Grunt which will start your local Jekyll server. | ||
4. Visit `http://127.0.0.1:4000/` to view your changes. | ||
To contribute to Stacks documentation or its CSS library, you'll need to install Stacks locally. View our [installation guidelines](https://stackoverflow.design/product/guidelines/installing). | ||
Having trouble getting these steps to work? Open [an issue](https://github.com/StackExchange/issues/new) with a `setup` tag. | ||
## What's included | ||
Within Stacks you’ll find the following directories and files: | ||
``` | ||
Stacks/ | ||
├── docs/ | ||
│ ├── _data/ | ||
│ ├── _includes/ | ||
│ ├── _layouts/ | ||
│ ├── assets/ | ||
| | ├── css/ | ||
| │ ├── img/ | ||
| │ ├── js/ | ||
| │ └── less/ | ||
│ ├── base/ | ||
│ ├── components/ | ||
│ ├── guidelines/ | ||
│ └── resources | ||
└── lib/ | ||
├── css/ | ||
├── src/ | ||
| ├── atomic/ | ||
│ ├── base/ | ||
│ ├── components/ | ||
│ └── exports/ | ||
├── stacks-dynamic.less | ||
├── stacks-static.less | ||
└── stacks.less | ||
``` | ||
Compiled and minified CSS for the core system is placed in a `lib/css/` folder. **Do not edit files in this folder as they are automatically generated from builds.** Any CSS directly related to the documentation website should be made within the `docs/assets/less` folder. | ||
1. `/docs` — This contains the documentation website about the Stacks system. | ||
2. `/lib` — This contains the Stacks system files. | ||
## Bugs and feature requests | ||
@@ -93,0 +52,0 @@ |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
9909
635557
61