README

Version: 7

Changelog: CHANGELOG.md

Demo

To see a live demo of Decanter v7 elements please view the v7 demo site. For more documentation on Version 7 please visit https://decanter.stanford.edu

Description

Decanter is a web design and development system for Stanford University. It includes a responsive layout system and a browsable collection of design patterns that can be used in any Stanford project. For Decanter v7, instead of using SASS/SCSS with the BEM naming convention, we use Tailwind CSS to generate utility classes with some customization needed for our Stanford design system.

Comprehensive Documentation

This repository includes extensive documentation to help you understand and use Decanter effectively. Places to start include:

1. README.md - Overview of Decanter, installation instructions, and quick start guide.
2. docs/README.md - Main documentation index with links to detailed guides.

Usage

When using Decanter, the package will automatically resolve to the correct module format:

// CommonJS - In your tailwind.config.js
module.exports = {
  presets: [require('decanter')],
  // your additional config...
}

// ES Module - In your tailwind.config.mjs  
import decanter from 'decanter';
export default {
  presets: [decanter],
  // your additional config...
}

The package exports both CommonJS (tailwind.config.js) and ES Module (tailwind.config.mjs) versions to ensure compatibility with different bundlers and configurations.

For detailed usage examples and configuration options, see docs/usage.md.

CSS Class Index

Comprehensive list of all custom CSS classes provided by Decanter.
See docs/index.md

Assets

We have removed all assets from the repo in Decanter v7. Instead, we are using remote third party resources for our fonts and icons.

Fonts

• We do not include any font assets with Decanter v7. If you want to use the Decanter fonts in your own projects, it is recommended that you use the font loading method that is optimized for your framework and only import the fonts that you need.
• We provided two font css files that you can import into your own project so you get the latest update from us. font.css includes all the fonts that are referenced in the Decanter design system (sans-serif, serif, slab, monospace, Stanford ligature font for the logo). font-basic.css includes only the essential sans-serif, serif and Stanford ligature fonts.
• For Source Sans 3, Source Serif 4, Roboto Slab, Roboto Mono - we include them using the @import method from Google Fonts.
• The Stanford ligature font that we use for the logo is linked from the University Communications media CDN.

Icons

• We have removed FontAwesome (dependency and asset) completely from Decanter v7. For those who would like to continue using FontAwesome, please feel free to do so and include them using methods that are suitable for your own projects.
• We recommend using the heroicons package as Hero Icons are created by the Tailwind CSS team and are open source. They can be included as SVG or JSX elements.

Accessibility

This project conforms to level AA WCAG 2.0 standards as required by the university's accessibility policy. For more information on the policy please visit: https://ucomm.stanford.edu/policies/accessibility-policy.html.