@stackoverflow/stacks - npm Package Compare versions

Comparing version 0.11.0 to 0.12.0

package.json

@@ -8,3 +8,3 @@ {
   },
-  "version": "0.11.0",
+  "version": "0.12.0",
   "unpkg": "lib/css/stacks.min.css",
@@ -28,4 +28,4 @@ "scripts": {
   "dependencies": {
-    "@stackoverflow/stacks-icons": "^1.2.0",
-    "autoprefixer": "^8.3.0",
+    "@stackoverflow/stacks-icons": "^1.4.0",
+    "autoprefixer": "^8.4.1",
     "postcss-less": "^1.1.3",
@@ -32,0 +32,0 @@ "postcss-sorting": "^3.1.0"

README.md

 # Stacks
 
-You’re looking at Stack Overflow’s CSS and Design Pattern Library. Stacks is an [atomic CSS library](http://johnpolacek.com/rethinking/) with classes and components for rapidly building Stack Overflow.
+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:
 
-## Including Stacks in your project
+ - Semantic and accessible component markup
+ - Cross-browser compatible Less / CSS
+ - An icon library
 
-If you’re working on Stack Overflow or Stack Overflow Careers, Stacks is already in production and you can use everything documented at https://stackoverflow.design/.
+Stacks documentation can be found at https://stackoverflow.design/
 
-If you’d like to include Stacks elsewhere—A blog, or a prototype—Stacks is available as a standalone library that’s delivered via [NPM](https://www.npmjs.com/package/@stackoverflow/stacks). This library includes everything within the `/lib/` directory.
 
+## 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
+
+You can use Stacks a few different ways.
+
+ 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):
+    ```bash
+    npm install --save @stackoverflow/stacks
+    ```
+ 3. You can also include a minified, compiled Stacks CSS style sheet:
+    ```html
+    <link rel="stylesheet" href="https://unpkg.com/@stackoverflow/stacks">
+    ```
+
+## Getting setup
+
+ 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 Grunt to compile our Less, rebuild the documentation site, minify things, and other items. You will need to install this and its various dependencies. To use Grunt. make sure you have [Node & NPM](https://nodejs.org/en/download/) installed.
+ 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 `grunt`. This is how you will start your local Jekyll server.
+ 4. Visit `http://127.0.0.1:4000/` to view your changes.
+
+Having trouble getting these steps to work? Open [an issue](https://gh.stackoverflow.com/Design/Stacks/issues/new) with a `setup` tag.
+
+## What's included
+
+Within Stacks you'll find the following directories and files:
+
 ```
-npm install --save-dev @stackoverflow/stacks
+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
 ```
 
-If you’d rather skip installing a dependency, you can include Stacks as you would normally any other CSS file. This relies on Unpkg’s CDN, and is always in sync, and up to date with `master`.
+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.
 
-``` html
-<link rel="stylesheet" href="https://unpkg.com/@stackoverflow/stacks" />
-```
+  1. `/docs` — This contains the documentation website about the Stacks system.
+  2. `/lib` — This contains the Stacks system files.
 
-## Documentation
+## Bugs and feature requests
 
-Stacks’ documentation is hosted at https://stackoverflow.design/
+Have a bug or feature request? First search existing or closed issues to make sure the issue hasn't been noted yet. If not, review our [issue guidelines](/CONTRIBUTING.md#open-an-issue) for submitting [a bug report](/CONTRIBUTING.md#reporting-bugs) or [feature request](/CONTRIBUTING.md#feature-requests).
 
+
 ## Contributing
 
-If you’d like to hack on Stacks and its documentation, check out our [Contributing guide](https://stackoverflow.design/guidelines/contributing).
+If you’d like to contribute to Stacks, please read through our [contribution guidelines](/CONTRIBUTING.md). Included are directions for opening issues, coding standards, and notes on development.
+
+## License
+
+Code and documentation copyright 2017-2018 Stack Exchange, Inc and released under the [MIT License](/LICENSE.MD).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

503193

increased by6.62%

Number of package files

45

increased by9.76%

Number of lines in readme file

102

increased by264.29%

Worsened metrics

Number of downloads

2684

decreased by-0.52%

Lines of code

6991

decreased by-4.87%

Dependency changes

• + Addedelectron-to-chromium@1.5.66(transitive)

• - Removedelectron-to-chromium@1.5.67(transitive)

• Updated@stackoverflow/stacks-icons@^1.4.0

• Updatedautoprefixer@^8.4.1