@stackoverflow/stacks
Advanced tools
Stack Overflow’s CSS and Design Pattern Library. Stacks is an atomic CSS library 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 interfaces and workflows that conform to Stack Overflow’s principles, design language, and best practices.
Our documentation is built with Stacks itself, using its immutable, atomic classes and components.
The Stacks website documents:
Stacks documentation can be found at https://stackoverflow.design/
Using Stacks is outlined in our usage guidelines.
To contribute to Stacks documentation or its CSS library, you’ll need to build Stacks locally. View our building guidelines.
Having trouble getting these steps to work? Open an issue with a setup label.
Format the source code with prettier via running:
npm run format
Run all lint suites by running:
npm run lint
Lint the styles (stylelint) by running:
npm run lint:css
Lint the typescript source code (eslint) via running:
npm run lint:ts
Lint the source code format (prettier) via running:
npm run lint:format
Run all test suites by running:
npm test
Unit/Component tests are written with DOM Testing Library. Please follow the library's principles and documentation to write tests.
Stacks uses Web Test Runner and Playwright to run tests in a real browser context.
Execute the unit/component tests suite by running:
npm run test:unit
or if you prefer watch mode run:
npm run test:unit:watch
Prerequisites:
git lfs (installation docs)docker (installation docs)pwsh (Installation docs)This Web Test Runner plugin is used to run visual regression tests. DOM Testing Library.
Visual regression tests end with this suffix *.visual.test.ts.
Execute the visual regression tests suite by running:
npm run test:visual
Update the visual baseline via:
npm run test:visual:update
Failing tests (including diffs) can be found under screenshots/[browser]/failed/ folders.
This is an experimental suite to test the generation of CSS from Less files.
Less tests end with this suffix *.less.test.ts.
Execute the less tests suite by running:
npm run test:less
Update the css snapshots via:
npm run test:less:update
Stacks uses Semantic Versioning, is distributed via npm, and publishes release notes on Github. Follow the steps below to release a new version of Stacks.
npm version [major | minor | patch]
git push && git push --tags
npm publish
develop into production and pushgit checkout production && git merge develop && git push
Head to Netlify, navigate to the Stacks overview, click on "Production deploys", and select "Deploy site" from the "Trigger deploy" dropdown.
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 for submitting a bug report or feature request.
If you’d like to contribute to Stacks, please read through our contribution guidelines. Included are directions for opening issues, coding standards, and notes on development.
Code and documentation copyright 2017-2022 Stack Exchange, Inc and released under the MIT License.
FAQs
Stack Overflow’s CSS and Design Pattern Library. Stacks is an atomic CSS library with classes and components for rapidly building Stack Overflow.
The npm package @stackoverflow/stacks receives a total of 2,106 weekly downloads. As such, @stackoverflow/stacks popularity was classified as popular.
We found that @stackoverflow/stacks demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 6 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.
Security News
The Ultralytics' PyPI Package was compromised four times in one weekend through GitHub Actions cache poisoning and failure to rotate previously compromised API tokens.