Most developers don't use OptiCSS directly. You may be looking for a style framework that uses it:
Overall architecture documentation.
This is a monorepo, there's different documentation available in the various packages:
These packages are what we expect others to have dependencies on. We are careful about their public APIs and backwards compatibility.
opticss
: The core library containing the optimizer. READMEtemplate-api
- The template analysis API.element-analysis
: The element analysis API.resolve-cascade
- A library that produces a resolved cascade for CSS
selectors against a DOM without using a browser. READMEutil
- Common utilities and data structures that we share across our project.These packages are extracted to allow them to be shared. You probably won't need to depend on them. As long as the other packages in this monorepo compile and pass tests we don't worry about backwards incompatibilty for these.
simple-template
- A custom template language we use for testing OptiCSS.attr-analysis-dsl
- A custom DSL for expressing attribute analysis succinctly.code-style
: The coding styleguide and linters for OptiCSS. READMEdemo-app
: An interactive demo of OptiCSS.