neobrutalismcss
Version:
NeoBrutalismCSS design framework that embraces the aesthetics of neo-brutalism in web
88 lines (55 loc) • 3.02 kB
Markdown
# NeoBrutalismCSS - Minimalist CSS Library
[](https://github.com/matifandy8/NeoBrutalismCSS/graphs/contributors)
**NeoBrutalismCSS** is a lightweight and minimalist CSS library inspired by the principles of neo-brutalist web design. It provides a set of simple and modular CSS classes to help you create brutalist-style web pages with ease.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Documentation](#documentation)
- [Contributing](#contributing)
- [License](#license)
## Installation
You can include NeoBrutalismCSS in your project in one of the following ways:
## Download
**Install with pnpm**
```sh
$ pnpm install neobrutalismcss
```
**Install with npm**
```sh
$ npm install neobrutalismcss
```
**Install with Yarn**
```sh
$ yarn add neobrutalismcss
```
### CDN
Include the following CSS link in the `<head>` section of your HTML file:
```html
<!-- Option 1: unpkg CDN (always latest version) -->
<link rel="stylesheet" href="https://unpkg.com/neobrutalismcss@latest" />
<!-- Option 2: jsDelivr CDN (specific version, or latest from GitHub) -->
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/matifandy8/NeoBrutalismCSS/dist/index.min.css" />
```
You can use either CDN. The unpkg link always points to the latest published npm version, while the jsDelivr link fetches the latest build from the GitHub repository (or you can specify a version/tag for more control).
## Fonts
NeoBrutalismCSS doesn't provide any fonts, but we do maintain the following list of fonts that we recommend for usage alongside our framework:
1. **Stint Ultra Expanded**
- [Font Link](https://fonts.google.com/specimen/Stint+Ultra+Expanded)
2. **Proza Libre**
- [Font Link](https://fonts.google.com/specimen/Proza+Libre)
3. **Lexend Mega**
- [Font Link](https://fonts.google.com/specimen/Lexend+Mega)
4. **Public Sans**
- [Font Link](https://fonts.google.com/specimen/Public+Sans)
These fonts can help you achieve a harmonious and visually appealing typography in your NeoBrutalismCSS-based projects. Please ensure that you follow the provided links to access and integrate these fonts into your designs according to your preferences and requirements.
## Usage
NeoBrutalismCSS only provides components. You will need to define your own layout.
To use NeoBrutalismCSS, simply add the CSS classes to your HTML elements.
Here docs - [WEB](https://matifandy8.github.io/NeoBrutalismCSS/)
## CSS Only
NeoBrutalismCSS only requires CSS and doesn't depend on any JavaScript.
## Documentation
For detailed documentation and examples, please visit the NeoBrutalismCSS Documentation.
## Contributing
We welcome contributions from the community. If you'd like to contribute to NeoBrutalismCSS, please see our [contribution guide](https://github.com/matifandy8/NeoBrutalismCSS/blob/main/.github/CONTRIBUTING.md).