Skip to content

Commit 229d5dd

Browse files
committed
feat: add v1 docs to vitepress and remove remaining vuepress files
1 parent f158219 commit 229d5dd

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+149
-357
lines changed

Diff for: .gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
11
/node_modules
2-
/.vuepress/dist
32
docs/.vitepress/dist
43
docs/.vitepress/cache

Diff for: .vuepress/1.0.js

-115
This file was deleted.

Diff for: .vuepress/config.js

-77
This file was deleted.

Diff for: .vuepress/enhanceApp.js

-14
This file was deleted.

Diff for: .vuepress/styles/index.styl

-8
This file was deleted.

Diff for: .vuepress/styles/palette.styl

-10
This file was deleted.

Diff for: docs/.vitepress/1.x.js

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
import prefix from './prefix';
2+
3+
export default (base) => [
4+
{
5+
text: 'Getting Started',
6+
collapsed: false,
7+
items: prefix(base, 'getting-started', [
8+
{text: 'Installation', link: ''},
9+
{text: 'Core Concepts', link: 'core-concepts'},
10+
{text: 'Directory Structure', link: 'directory-structure'},
11+
]),
12+
},
13+
{
14+
text: 'Tutorial',
15+
collapsed: true,
16+
items: prefix(base, 'tutorial', [
17+
{text: '1. Getting Started', link: ''},
18+
{text: '2. Models', link: '02-models'},
19+
{text: '3. Server and Schemas', link: '03-server-and-schemas'},
20+
{text: '4. Relationships', link: '04-relationships'},
21+
{text: '5. Creating Resources', link: '05-creating-resources'},
22+
{text: '6. Modifying Resources', link: '06-modifying-resources'},
23+
{text: '7. Deleting Resources', link: '07-deleting-resources'},
24+
{text: '8. Fetching Resources', link: '08-fetching-resources'},
25+
]),
26+
},
27+
{
28+
text: 'Servers',
29+
collapsed: false,
30+
items: prefix(base, 'servers', [
31+
{text: 'The Basics', link: ''},
32+
{text: 'Events', link: 'events'},
33+
]),
34+
},
35+
{
36+
text: 'Schemas',
37+
collapsed: false,
38+
items: prefix(base, 'schemas', [
39+
{text: 'The Basics', link: ''},
40+
{text: 'Identifier', link: 'identifier'},
41+
{text: 'Attributes', link: 'attributes'},
42+
{text: 'Relationships', link: 'relationships'},
43+
{text: 'Eager Loading', link: 'eager-loading'},
44+
{text: 'Sorting', link: 'sorting'},
45+
{text: 'Pagination', link: 'pagination'},
46+
{text: 'Filters', link: 'filters'},
47+
{text: 'Soft Deleting', link: 'soft-deleting'},
48+
]),
49+
},
50+
{
51+
text: 'Routing',
52+
collapsed: false,
53+
items: prefix(base, 'routing', [
54+
{text: 'Routing', link: ''},
55+
{text: 'Controllers', link: 'controllers'},
56+
{text: 'Writing Actions', link: 'writing-actions'},
57+
{text: 'Custom Actions', link: 'custom-actions'},
58+
]),
59+
},
60+
{
61+
text: 'Requests',
62+
collapsed: false,
63+
items: prefix(base, 'requests', [
64+
{text: 'The Basics', link: ''},
65+
{text: 'Authorization', link: 'authorization'},
66+
{text: 'JSON:API Compliance', link: 'compliance'},
67+
{text: 'Resources', link: 'resources'},
68+
{text: 'Query Parameters', link: 'query-parameters'},
69+
]),
70+
},
71+
{
72+
text: 'Responses',
73+
collapsed: false,
74+
items: prefix(base, 'responses', [
75+
{text: 'JSON:API Documents', link: ''},
76+
{text: 'Errors', link: 'errors'},
77+
]),
78+
},
79+
{
80+
text: 'API Resources',
81+
collapsed: true,
82+
items: prefix(base, 'resources', [
83+
{text: 'The Basics', link: ''},
84+
{text: 'Attributes', link: 'attributes'},
85+
{text: 'Relationships', link: 'relationships'},
86+
{text: 'Meta', link: 'meta'},
87+
{text: 'Links', link: 'links'},
88+
]),
89+
},
90+
{
91+
text: 'Digging Deeper',
92+
collapsed: false,
93+
items: prefix(base, 'digging-deeper', [
94+
{text: 'Artisan Console', link: 'artisan'},
95+
{text: 'Countable', link: 'countable'},
96+
{text: 'Localisation', link: 'localisation'},
97+
{text: 'Proxies', link: 'proxies'},
98+
{text: 'Non-Eloquent Models', link: 'non-eloquent'},
99+
{text: 'Polymorphic to Many', link: 'polymorphic-to-many'},
100+
]),
101+
},
102+
{
103+
text: 'Testing',
104+
collapsed: false,
105+
items: prefix(base, 'testing', [
106+
{text: 'Getting Started', link: ''},
107+
{text: 'Resources', link: 'resources'},
108+
{text: 'Relationships', link: 'relationships'},
109+
{text: 'Requests', link: 'requests'},
110+
{text: 'Assertions', link: 'assertions'},
111+
]),
112+
},
113+
];

Diff for: docs/.vitepress/config.mts

+3
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@ import {defineConfig} from 'vitepress';
22
import v4 from './4.x';
33
import v3 from './3.x';
44
import v2 from './2.x';
5+
import v1 from './1.x';
56

67
// https://vitepress.dev/reference/site-config
78
export default defineConfig({
@@ -16,6 +17,7 @@ export default defineConfig({
1617
{text: '4.x', link: '/4.x/'},
1718
{text: '3.x', link: '/3.x/'},
1819
{text: '2.x', link: '/2.x/'},
20+
{text: '1.x', link: '/1.x/'},
1921
],
2022
},
2123
],
@@ -24,6 +26,7 @@ export default defineConfig({
2426
'/4.x/': v4('/4.x'),
2527
'/3.x/': v3('/3.x'),
2628
'/2.x/': v2('/2.x'),
29+
'/1.x/': v1('/1.x'),
2730
},
2831

2932
socialLinks: [

Diff for: 1.0/digging-deeper/artisan.md renamed to docs/1.x/digging-deeper/artisan.md

+1-3
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# Artisan Console
22

3-
[[toc]]
4-
53
## Generators
64

75
Laravel JSON:API ships with a comprehensive set of generators, so that
@@ -150,7 +148,7 @@ php artisan jsonapi:schema posts --model="\App\Foo\Bar\BlogPost" --server=v1
150148
```
151149
:::
152150

153-
If you are generating a schema for a [multi-resource model](./proxies.md),
151+
If you are generating a schema for a [multi-resource model](proxies.md),
154152
you should use the `--proxy` option when creating a schema for a proxy class.
155153

156154
As with other commands, use the `--force` option if you need to overwrite

0 commit comments

Comments
 (0)