@stackoverflow/stacks 2.8.5 → 3.0.0-beta.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +29 -0
  2. package/dist/css/stacks.min.css +1 -1
  3. package/package.json +1 -1
package/README.md ADDED
@@ -0,0 +1,29 @@
1
+ # Stacks
2
+
3
+ [![ci status][gh-action-badge]][gh-action-url] [![npm version][npm-badge]][npm-url]
4
+
5
+ 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.
6
+
7
+ Our documentation is built with Stacks itself, using its [immutable, atomic classes](http://johnpolacek.com/rethinking/) and components.
8
+
9
+ The [Stacks website](https://stackoverflow.design/) documents:
10
+
11
+ ## Product
12
+ - Semantic and accessible component markup
13
+ - Cross-browser compatible Less / CSS
14
+ - An [icon library](https://github.com/StackExchange/Stacks-Icons)
15
+
16
+ ## Email
17
+ - Email templates & components
18
+
19
+ # Using Stacks
20
+ Using Stacks is outlined in our [usage guidelines](https://stackoverflow.design/product/develop/using-stacks).
21
+
22
+ ## Migrating from v1 to v2
23
+
24
+ To migrate from Stacks v1 to v2, see our [migration guide](/MIGRATION_GUIDE.md).
25
+
26
+ [gh-action-url]: https://github.com/StackExchange/Stacks/actions/workflows/main.yml
27
+ [gh-action-badge]: https://github.com/StackExchange/Stacks/actions/workflows/workflow.yml/badge.svg?branch=develop
28
+ [npm-url]: https://npmjs.org/package/@stackoverflow/stacks
29
+ [npm-badge]: https://img.shields.io/npm/v/@stackoverflow/stacks.svg