Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sarmaged committed Jun 18, 2024
1 parent 5c0113a commit 375d9ac
Showing 1 changed file with 2 additions and 61 deletions.
63 changes: 2 additions & 61 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,70 +6,11 @@
![license](https://img.shields.io/npm/l/style-forge.base)
![build](https://github.com/Sarmaged/style-forge.base/actions/workflows/publish.yml/badge.svg)

## Description

`Style-Forge.Base` provides the foundational CSS variables and base styles for the Style Forge framework. It includes essential typography, color schemes, and utility classes, ensuring a consistent and customizable design system for your web projects.

## Installation

You can install the package via npm or yarn:

```bash
npm install style-forge.base
```

```bash
yarn add style-forge.base
```

## Usage

After installation, you can import the CSS file into your project:

```css
@import "style-forge.base";
```

Or, if you are using Webpack or another module bundler:

```js
import 'style-forge.base';
```

## Variables

`--sf-c` - these are colors in HSL

```css
:root {
--sf-base-ff: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol';
--sf-base-fw: 400;
--sf-base-fz: 1rem;
--sf-base-lh: 0.8;

--sf-h1: 3rem;
--sf-h2: 2.5rem;
--sf-h3: 2rem;
--sf-h4: 1.5rem;
--sf-h5: 1.25rem;
--sf-h6: 1rem;

--sf-txt-small: 0.75rem;

--sf-disabled: 0.4; /* opacity */

--sf-c-link: 225 73% 57%; /* <a> - color */

--sf-c-mark-bg: 60 100% 50%; /* <mark> - background */
--sf-c-mark-txt: 0 0% 10%; /* <mark> - color */
## Description

--sf-c-txt: 0 0% 10%; /* All color */
--sf-c-bg: 0 0% 100%; /* All background */
--sf-c-bd: 0 0% 75%; /* All border */
--sf-c-shape-bg: 0 0% 90%; /* <pre> - background */
--sf-c-backdrop: 0 0% 10%; /* ::backdrop */
}
```
To check out docs, visit [style-forge.dev](https://style-forge.dev/base/)

## Contributing

Expand Down

0 comments on commit 375d9ac

Please sign in to comment.