@nib/css-framework
v1.0.0
Published
CSS utilities and component styles for non-react projects
Downloads
578
Maintainers
Readme
CSS Framework
Tailwind-powered CSS Framework.
This documentation was written using Svelte.
Guidelines
- We have removed some of the default variants in the
tailwind.config.js
file (to save space) - Breakpoints: Currently only have 2 (
md
(640px),xl
(960px)) - Tailwind Intellisense vscode plugin is mint
- Spacing in the theme determines the
w-*
utilities
Adding the CSS Framework to your App
Using CDN
Add the
styles.min.css
via CDN into yourindex.html
:<link href="https://unpkg.com/@nib/css-framework@^1.0.0/dist/styles.min.css" rel="stylesheet" />
This will give you version
1.0.0
. To get the latest version, remove@^1.0.0
from thehref
.
Getting started
To get started:
Clone the repository:
git clone [email protected]:nib-group/css-framework.git
Install the dependencies:
# Using npm npm install # Using Yarn yarn
Build the
dist
folder:# Using npm npm run build # Using Yarn yarn run build
This will build out the
dist/styles.css
anddist/styles.min.css
files used by the docs.To optimise the CSS for production, cssnano has been used for the minified styles.
Start the development server:
# Using npm npm run dev # Using Yarn yarn run dev
Now you should be able to see the project running at localhost:5000.
Any questions?
If there are any questions about this process you can ask us at the #designops slack channel.