-
Notifications
You must be signed in to change notification settings - Fork 314
/
Copy pathindex.mdx
160 lines (152 loc) · 3.72 KB
/
index.mdx
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
---
meta:
title: "Documentation"
description:
"Explore the documentation to learn how to build realtime collaborative
experiences with Liveblocks."
showTitle: false
---
<DocsHomepageHero
title="Documentation"
description="Liveblocks is the platform for adding collaborative editing, comments, and notifications into your application."
actions={[
{
title: "Get started",
href: "/docs/get-started",
appearance: "primary",
},
{
title: "Browse examples",
href: "/examples",
},
]}
/>
<DocsHomepageGrid />
## API Reference
<ListGrid columns={2}>
<DocsCard
type="technology"
title="JavaScript"
href="/docs/api-reference/liveblocks-client"
description="@liveblocks/client"
visual={<DocsJavascriptIcon />}
/>
<DocsCard
type="technology"
title="React"
href="/docs/api-reference/liveblocks-react"
description="@liveblocks/react"
visual={<DocsReactIcon />}
/>
<DocsCard
type="technology"
title="React UI"
href="/docs/api-reference/liveblocks-react-ui"
description="@liveblocks/react-ui"
visual={<DocsReactIcon />}
/>
<DocsCard
type="technology"
title="React Lexical"
href="/docs/api-reference/liveblocks-react-lexical"
description="@liveblocks/react-lexical"
visual={<DocsReactIcon />}
/>
<DocsCard
type="technology"
title="Node Lexical"
href="/docs/api-reference/liveblocks-node-lexical"
description="@liveblocks/node-lexical"
visual={<DocsNodejsIcon />}
/>
<DocsCard
type="technology"
title="Redux"
href="/docs/api-reference/liveblocks-redux"
description="@liveblocks/redux"
visual={<DocsReduxIcon />}
/>
<DocsCard
type="technology"
title="Zustand"
href="/docs/api-reference/liveblocks-zustand"
description="@liveblocks/zustand"
visual={
<img
alt=""
src="/assets/zustand.png"
width={24}
height={24}
loading="lazy"
/>
}
/>
<DocsCard
type="technology"
title="Yjs"
href="/docs/api-reference/liveblocks-yjs"
description="@liveblocks/yjs"
visual={<DocsYjsIcon className="fill-product-icon-brand h-auto w-6" />}
/>
<DocsCard
type="technology"
title="Node.js"
href="/docs/api-reference/liveblocks-node"
description="@liveblocks/node"
visual={<DocsNodejsIcon />}
/>
<DocsCard
type="technology"
title="REST API"
href="/docs/api-reference/rest-api-endpoints"
description="HTTP endpoints"
visual={<DocsApiIcon />}
/>
</ListGrid>
## Examples
<ListGrid columns={2}>
<ExampleCard
example={{
title: "Live Cursors",
slug: "live-cursors",
image: "/images/examples/thumbnails/live-cursors.jpg",
}}
technologies={["nextjs", "vuejs", "sveltekit", "solidjs", "javascript"]}
openInNewWindow
/>
<ExampleCard
example={{
title: "Collaborative Whiteboard",
slug: "collaborative-whiteboard-advanced",
image:
"/images/examples/thumbnails/collaborative-whiteboard-advanced.jpg",
advanced: true,
}}
technologies={["nextjs"]}
openInNewWindow
/>
</ListGrid>
## Community
<ListGrid columns={3}>
<DocsCard
title="X"
href="https://x.com/liveblocks"
description="Follow us on X for the latest news and updates."
visual={<DocsXIcon />}
openInNewWindow
/>
<DocsCard
title="Discord"
href="https://liveblocks.io/discord"
description="Join hundreds of developers building with Liveblocks."
visual={<DocsDiscordIcon />}
openInNewWindow
/>
<DocsCard
title="GitHub"
href="https://github.com/liveblocks/liveblocks"
description="Follow progress and contribute to the codebase."
visual={<DocsGithubIcon />}
openInNewWindow
/>
</ListGrid>