Skip to content

danimatuko/smoojy

Repository files navigation

Smoojy

Smoojy is a lightweight and intuitive CSS framework designed to simplify the process of building modern and responsive web interfaces. It provides a set of pre-built components, styles, and utilities that you can easily customize and integrate into your projects.

Features

  • Responsive Design: Smoojy ensures your web pages look great on any device or screen size.
  • Customizable: Easily modify the default styles and components to fit your project's specific requirements.
  • Lightweight: Smoojy is designed to be lightweight, ensuring fast load times and optimal performance.
  • Flexbox Grid System: The grid system allows you to create flexible and responsive layouts.
  • Simplified Typography: Smoojy provides a consistent and clean typographic style out of the box.
  • CSS Variables: Leverage CSS variables to quickly change global styles and create a consistent design system.
  • Cross-Browser Compatibility: Smoojy is compatible with all modern browsers, ensuring consistent rendering across different platforms.
  • Easy to Learn: The framework has a minimal learning curve, making it accessible for developers of all skill levels.

Getting Started

These instructions will help you get Smoojy up and running in your project.

Installation

You can include Smoojy in your project by either downloading the compressed CSS file or using a package manager.

Download

  1. Visit the Smoojy GitHub repository.
  2. Click on the Code button and select Download ZIP.
  3. Extract the downloaded ZIP file to your project directory.
  4. Link the smoojy.min.css file in your HTML file:
<link rel="stylesheet" href="path/to/smoojy.min.css" />

Package Manager

Smoojy can also be installed via popular package managers like npm or Yarn.

npm
npm install @danimatuko/smoojy
Yarn
yarn add @danimatuko/smoojy

After installation, you can import Smoojy into your project's CSS file:

@import "@danimatuko/smoojy/dist/smoojy.min.css";

Usage

Once you have included Smoojy in your project, you can start using its classes and components.

CSS Classes

Smoojy provides a wide range of utility classes that you can apply directly to your HTML elements. These classes help you control layout, spacing, typography, colors, and more. Refer to the documentation for a comprehensive list of available classes and their usage.

Components

Smoojy includes several pre-built components that you can use to quickly assemble your user interface. These components include buttons, forms, navigation menus, cards, and more. Refer to the documentation for detailed usage instructions and examples.

Customization

You can easily customize Smoojy to match your project's branding and design requirements. The framework provides a set of CSS variables that you can override with your own values. By modifying these variables, you can change colors, spacing, typography, and other aspects of the framework. Refer to the documentation for a detailed guide on customization options.

Contributing

Thank you for considering contributing to Smoojy! If you have any bug reports, feature requests, or suggestions, please open an issue on the GitHubrepository.

If you would like to contribute code, please follow the guidelines outlined in the CONTRIBUTING.md file.

License

Smoojy is open-source software licensed under the MIT license.

Conclusion

Smoojy is a versatile CSS framework that offers a streamlined approach to building responsive web interfaces. With its lightweight nature, customizable options, and comprehensive set of components and utilities, Smoojy empowers developers to create visually appealing and user-friendly websites. Get started with Smoojy today and enjoy the benefits of a flexible and efficient CSS framework.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published