librecss v0.9.7

Libre CSS

A Free and Open-Source CSS Framework Built for Fast UI Development

Documentation

The official documentation site for Libre CSS is currently in development.

For now, head to DOCS.md to see all available classes.

Quick installation

with npm:

npm install librecss

with yarn:

yarn add librecss

Import

You can now import the file like so:

import "librecss/src/libre.css";

CDN

with unpkg:

<link
  rel="stylesheet"
  type="text/css"
  href="https://unpkg.com/librecss@latest/src/libre.min.css"
/>

with jsDelivr:

<link
  rel="stylesheet"
  type="text/css"
  href="https://cdn.jsdelivr.net/npm/librecss@latest/src/libre.min.css"
/>

Only CSS

Libre only gives you a CSS file which means you have to implement JavaScript yourself.

Contributing

If you want to contribute to this project, consider reading the CODE_OF_CONDUCT.md first. Feel free to open an issue for any bugs, issues, or if you have any feature requests.

1. Fork and clone this repository:

git clone https://github.com/<username>/librecss

2. Create a new branch:

git checkout -b new_branch

# Check if the branch is correct
git branch

# You should see this
  main
* new_branch

3. Install dependencies:

yarn

# if you use npm, remove `yarn.lock` then run:
npm install

4. Run scripts needed when making some changes:

# Compiles all SCSS
yarn compile

# Run a localhost where you can test the components
yarn dev

# Minifies all CSS
yarn minify

Don't forget to run yarn minify after you're done making changes.

5. Make some changes

6. Push changes to your fork:

git add .
git commit -m "commit description"
git push -u origin new_branch

7. Submit a pull request.

Support this project

Leaving this repository a star means a lot to me!

License

This project is under the MIT license.