Skip to content

Commit

Permalink
📝 Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
wandersonsales-dev committed Jun 13, 2024
1 parent 5ceee2a commit 2ce74ee
Show file tree
Hide file tree
Showing 4 changed files with 118 additions and 8 deletions.
109 changes: 104 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@squidit/react-css",
"version": "1.0.5",
"version": "1.0.6",
"scripts": {
"format": "prettier --write --parser typescript '**/*.{ts,tsx}'",
"lint": "eslint src --ext js,ts,tsx",
Expand Down Expand Up @@ -80,6 +80,8 @@
"@types/react": "^18.2.31",
"@typescript-eslint/eslint-plugin": "^6.9.0",
"@typescript-eslint/parser": "^6.9.0",
"@vitejs/plugin-react": "^4.3.1",
"@vitejs/plugin-react-refresh": "^1.3.6",
"@vitest/coverage-v8": "^0.34.6",
"@vitest/ui": "^0.34.6",
"eslint": "^8.52.0",
Expand Down
10 changes: 9 additions & 1 deletion src/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,15 @@ npm install @squidit/css @squidit/react-css
yarn add @squidit/css @squidit/react-css
```

3. Configure css in your project according to the @squidit/css documentation described in the project's [README](https://github.com/squidit/css/blob/master/README.md)
3. Add to your style.scss main file

Example:

```css
$fontsFolderPath: "@squidit/css/dist/fonts";
@import "@squidit/css/src/scss/squid.scss";
@import "@squidit/react-css/dist/style.css";
```

## How to Use

Expand Down
3 changes: 2 additions & 1 deletion vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ import { defineConfig } from 'vite'
import dts from 'vite-plugin-dts'
import { peerDependencies } from './package.json'
import path from 'path'
import react from '@vitejs/plugin-react'

export default defineConfig({
build: {
Expand All @@ -18,7 +19,7 @@ export default defineConfig({
sourcemap: true, // Generates source maps for debugging.
emptyOutDir: true, // Clears the output directory before building.
},
plugins: [dts()], // Uses the 'vite-plugin-dts' plugin for generating TypeScript declaration files (d.ts).
plugins: [dts(), react()], // Uses the 'vite-plugin-dts' plugin for generating TypeScript declaration files (d.ts).
test: {
globals: true,
environment: 'jsdom',
Expand Down

0 comments on commit 2ce74ee

Please sign in to comment.