Skip to content

Commit 1812aeb

Browse files
docs: add features section, customize theme, improve wording
1 parent e2b8edd commit 1812aeb

File tree

4 files changed

+29
-2
lines changed

4 files changed

+29
-2
lines changed

docs/.vitepress/theme/custom.css

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:root {
2+
--vp-c-brand-1: #003e99;
3+
--vp-c-brand-2: #0da4d2;
4+
--vp-c-brand-3: #0BBAEE;
5+
--vp-c-brand-soft: rgba(11, 185, 238, 0.765);
6+
}
7+
8+
.dark {
9+
--vp-c-brand-1: #0BBAEE;
10+
--vp-c-brand-2: #0046af;
11+
--vp-c-brand-3: #003e99;
12+
--vp-c-brand-soft: rgba(0, 61, 153, 0.765);
13+
}

docs/.vitepress/theme/index.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import DefaultTheme from 'vitepress/theme'
2+
import './custom.css'
3+
4+
export default DefaultTheme

docs/pages/index.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,17 @@ hero:
99
- theme: brand
1010
text: Get Started
1111
link: /installation
12+
- theme: alt
13+
text: How to use
14+
link: /basic-usage
1215

1316
features:
14-
- title: TODO
17+
- title: 🧘🏻‍♂️ Unified Resources
18+
details: Provide multiple resource representations through a single resource class.
19+
- title: 🏗️ Built-in States
20+
details: Comes with default states for common use cases.
21+
- title: 🪄 Magic Methods
22+
details: Optional magic methods for a more fluent and expressive syntax.
23+
- title: 🛠️ Hackable
24+
details: Extend the package with your own custom states and logic.
1525
---

docs/pages/installation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Install the package via composer:
1313
composer require farbcode/laravel-stateful-resources
1414
```
1515

16-
Publish the config file with:
16+
Publish the configuration file with:
1717

1818
```bash
1919
php artisan vendor:publish --tag="stateful-resources-config"

0 commit comments

Comments
 (0)