ThinkUniform/uniformcss.com: Documentation site for Uniform CSS. · GitHub

A fully configurable utility class generator and
CSS framework built for Sass projects.
Explore the docs »

View Site · Report Bug · Request Feature

1. Introduction
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
   • Compiling Sass
3. Community
4. Contributing
5. License
   • Source Code
   • Web Content
6. Contact
7. Acknowledgements

This respository houses the official documentation site for Uniform CSS, a fully configurable utility class generator and CSS framework built for Sass projects. To see documentation, visit uniformcss.com

• 🚀 Learn everything you need to know to install, customize, and get started with Uniform CSS
• 📋 Quickly find any utility you're looking for with an alphabetically ordered API reference
• 🎨 Get a visual reference of every color, size, font-size, and effects

This project was built with the following tools and technologies.

• Sass
• Eleventy
• AlpineJS

Here are the instructions on setting up this project locally. To get a local copy up and running make sure you have the prerequisites set up before continuing on with the installation steps.

Before you get started, ensure you have the following installed.

• Node & NPM
• Sass v1.33.0 or higher

To install and run this project locally, follow these simple example steps.

1. Clone this repo

   git clone https://github.com/ThinkUniform/uniformcss.com.git

2. Install NPM packages

   npm install

3. Run Eleventy from your terminal

   npx eleventy --serve

This project uses a pre-configured version of Uniform CSS. Making changes and compiling is the same as any other Uniform CSS setup. Follow these steps to compile and watch for changes.

1. Install Dart Sass

   brew install sass/sass/sass

2. Compile Sass and watch for changes

   yarn uniform:watch-compressed

If you're ever stuck, need help, or wish to have a general discussion about this project, please get involved with the following community channels.

• Twitter
• Discord
• Github Discussions

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Thanks to all the people that have contributed in making this project great!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

The source code is licensed under the MIT agreement. You are more than welcome to clone and customize this repo to suit your needs.

Website content is licensed under CC BY-NC-SA 4.0

1. Share — copy and redistribute the material in any medium or format
2. Adapt — remix, transform, and build upon the material

1. Attribution — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.

2. NonCommercial — You may not use the material for commercial purposes.

3. ShareAlike — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.

4. No additional restrictions — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

Jin Su Park – Creator and Author
@jinsu • jinsupark.com

This project would not have been possible without the genius minds behind the following tools, products and languages. Thank you for your contribution.

• Sass
• Eleventy
• Netlify
• Inter Font
• AlpineJS
• Ionicons