Skip to content

Commit 2d64b30

Browse files
kearfykearfy
committed
Improve
1 parent 7d21f51 commit 2d64b30

File tree

4 files changed

+79
-10
lines changed

4 files changed

+79
-10
lines changed

‎astro.config.mjs

-8
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,6 @@ import { autolinkConfig } from './src/util/rehypeHeadingsConfig';
1414
import { rehypeNotesPlugin } from './src/util/rehypeNotesPlugin.mjs';
1515

1616
import sitemap from '@astrojs/sitemap';
17-
import llms from 'vite-plugin-llms';
1817

1918
const deployDomain = process.env.DEPLOY_DOMAIN ?? 'surrealdb.com';
2019
const site = `https://${deployDomain}`;
@@ -48,11 +47,4 @@ export default defineConfig({
4847
],
4948
syntaxHighlight: false,
5049
},
51-
vite: {
52-
plugins: [
53-
llms({
54-
llmsDir: 'dist/docs',
55-
}),
56-
],
57-
},
5850
});

‎bun.lockb

-408 Bytes
Binary file not shown.

‎package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -59,8 +59,7 @@
5959
"tailwind-merge": "^2.5.4",
6060
"tailwindcss": "^3.4.15",
6161
"typescript": "^5.6.3",
62-
"unist-util-visit": "^5.0.0",
63-
"vite-plugin-llms": "^1.0.2"
62+
"unist-util-visit": "^5.0.0"
6463
},
6564
"devDependencies": {
6665
"@biomejs/biome": "1.8.3",

‎public/llms.txt

+78
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
SurrealDB is a [multi-model Database](https://surrealdb.com/features/multi-model-database) that allows you to store and manage date in relational, document, graph, time-series, vector & search and key-value models in one place.
2+
3+
Unified by a powerful SQL like query language [SurrealQL](https://surrealdb.com/docs/surrealql), you can query SurrealDB in ways that are familiar to you, but with the power of a modern database. In addition, SurrealDB is designed to be [distributed and scalable](https://surrealdb.com/docs/surrealdb/introduction/architecture), allowing you to build and scale your applications with ease.
4+
5+
Also providing additional query methods like [GraphQL](https://surrealdb.com/docs/surrealdb/querying/graphql), [HTTP](https://surrealdb.com/docs/surrealdb/integration/http) and [RPC](https://surrealdb.com/docs/surrealdb/integration/rpc), you can also query SurrealDB in your native environments using [SDKs](https://surrealdb.com/docs/surrealdb/integration/sdks), we support [JavaScript](https://surrealdb.com/docs/sdk/javascript), [Python](https://surrealdb.com/docs/sdk/python), [Go](https://surrealdb.com/docs/sdk/golang), [Rust](https://surrealdb.com/docs/sdk/rust), [Java](https://surrealdb.com/docs/sdk/java) and [.NET](https://surrealdb.com/docs/sdk/dotnet).
6+
7+
Things to remember when working with SurrealDB:
8+
9+
- SurrealDB combines different data models in a single database, allowing you to store and manage date in [relational, document, graph, time-series, vector & search and key-value models in one place](https://surrealdb.com/features/multi-model-database)
10+
- It supports multiple query languages including [SurrealQL (native)](https://surrealdb.com/docs/surrealql), [RPC](https://surrealdb.com/docs/surrealdb/integration/rpc), [CBOR](https://surrealdb.com/docs/surrealdb/integration/cbor) and [HTTP API](https://surrealdb.com/docs/surrealdb/integration/http)
11+
- Can be [embedded directly in applications](https://surrealdb.com/docs/surrealdb/embedding) or [run as a standalone service](https://surrealdb.com/docs/surrealdb/installation/running)
12+
- Provides real-time data synchronization and live queries
13+
- Provides a [REST API](https://surrealdb.com/docs/surrealdb/integration/http) and [WebSocket](https://surrealdb.com/docs/surrealdb/integration/websocket) for real-time updates
14+
- Provides a [GraphQL API](https://surrealdb.com/docs/surrealdb/querying/graphql) for querying data
15+
- Provides a [RPC API](https://surrealdb.com/docs/surrealdb/integration/rpc) for querying data
16+
- Provides a [CBOR API](https://surrealdb.com/docs/surrealdb/integration/cbor) for querying data
17+
- Provides a [SurrealQL](https://surrealdb.com/docs/surrealql) for querying data
18+
19+
20+
## Get Started
21+
22+
- [SurrealDB Installation Guide](https://surrealdb.com/docs/installation): Detailed instructions for installing SurrealDB
23+
- [SurrealDB Quick Start](https://surrealdb.com/docs/quickstart): A step-by-step guide to get you started with SurrealDB
24+
- [Get started with Surreal Cloud](https://surrealdb.com/docs/cloud/getting-started): A guide to get you started with Surreal Cloud
25+
- [Get started by installing SurrealDB](https://surrealdb.com/docs/surrealdb/introduction/start#getting-started-by-installing-surrealdb): A guide to get you started in-memory, Single-node On-Disk, Single Node On-disk, and Multi-node scalable deployments of SurrealDB
26+
- [Get started with JavaScript SDK](https://surrealdb.com/docs/sdk/javascript/start): A guide to get you started with the JavaScript SDK
27+
- [Get started with Rust SDK](https://surrealdb.com/docs/sdk/rust/setup): A guide to get you started with the Rust SDK
28+
- [Get started with Java SDK](https://surrealdb.com/docs/sdk/java/start): A guide to get you started with the Java SDK
29+
- [Get started with Golang SDK](https://surrealdb.com/docs/sdk/golang/start): A guide to get you started with the Golang SDK
30+
- [Get started with .NET SDK](https://surrealdb.com/docs/sdk/dotnet/start): A guide to get you started with the .NET SDK
31+
- [Get started with PHP SDK](https://surrealdb.com/docs/sdk/php): A guide to get you started with the PHP SDK
32+
33+
## Docs
34+
35+
- [SurrealDB Documentation](https://surrealdb.com/docs/surrealdb): Comprehensive documentation for SurrealDB
36+
- [SurrealQL Documentation](https://surrealdb.com/docs/surrealql): Documentation for SurrealDB's query language
37+
- [Surrealist Documentation](https://surrealist.com/docs/introduction): Documentation for Surrealist, database management interface
38+
- [Surreal Cloud Documentation](https://surrealdb.com/docs/cloud): Documentation for Surreal Cloud, the cloud-based version of SurrealDB
39+
- [JavaScript SDK Documentation](https://surrealdb.com/docs/javascript/introduction): Documentation for the JavaScript SDK
40+
- [Python SDK Documentation](https://surrealdb.com/docs/python/introduction): Documentation for the Python SDK
41+
- [Go SDK Documentation](https://surrealdb.com/docs/golang/introduction): Documentation for the Go SDK
42+
- [Rust SDK Documentation](https://surrealdb.com/docs/rust/introduction): Documentation for the Rust SDK
43+
- [SurrealDB CLI](https://surrealdb.com/docs/cli): Command line interface documentation
44+
- [HTTP Integration](https://surrealdb.com/docs/integration/http): Guide for using SurrealDB's HTTP API
45+
- [Security Documentation](https://surrealdb.com/docs/surrealdb/security): Security and permissions management
46+
47+
## Deployment
48+
49+
- [Deploy on Surreal Cloud](https://surrealdb.com/docs/surrealdb/deployment/surreal-cloud)
50+
- [Deploy on Fly.io](https://surrealdb.com/docs/surrealdb/deployment/fly)
51+
- [Deploy on Kubernetes](https://surrealdb.com/docs/surrealdb/deployment/kubernetes)
52+
- [Deploy on Amazon Elastic Kubernetes Service(EKS)](https://surrealdb.com/docs/surrealdb/deployment/amazon)
53+
- [Deploy on Azure Kubernetes Service (AKS)](https://surrealdb.com/docs/surrealdb/deployment/azure)
54+
- [Deploy on Google Kubernetes Engine(GKE)](https://surrealdb.com/docs/surrealdb/deployment/google)
55+
56+
## Educational Resources
57+
58+
- [SurrealDB Tutorials](https://surrealdb.com/docs/surrealdb/tutorials)
59+
- [SurrealDB University](https://surrealdb.com/learn)
60+
- [Aeon's Surreal Renaissance](https://surrealdb.com/learn/book)
61+
- [Surreal Sidekick](https://surrealist.app/cloud/chat)
62+
63+
## Raw markdown content
64+
65+
To find the raw markdown content for a route, follow these instructions:
66+
- For a route which matches `/docs/sdk/{language}/{...path}`, you can translate it to either of:
67+
- https://raw.githubusercontent.com/surrealdb/docs.surrealdb.com/refs/heads/main/src/content/doc-sdk-{language}/{path}.md(x?)
68+
- https://raw.githubusercontent.com/surrealdb/docs.surrealdb.com/refs/heads/main/src/content/doc-sdk-{language}/{path}/index.md(x?)
69+
- For a route which matches `/docs/{doc}/{...path}`, you can translate it to either of:
70+
- https://raw.githubusercontent.com/surrealdb/docs.surrealdb.com/refs/heads/main/src/content/doc-{doc}/{path}.md(x?)
71+
- https://raw.githubusercontent.com/surrealdb/docs.surrealdb.com/refs/heads/main/src/content/doc-{doc}/{path}/index.md(x?)
72+
73+
Notice the ending file extension (`.md(x?)`), by this I mean that the file extension may be either of `.md` or `.mdx`, however `.mdx` is most likely to be the file extension.
74+
For either of the two criteria, if the ending `/{...path}` is missing, the file under the `content/doc-{...}` folder will be `index.md(x?)`
75+
76+
### Example:
77+
- Website route: /docs/sdk/javascript/data-types
78+
- Raw markdown URL: https://raw.githubusercontent.com/surrealdb/docs.surrealdb.com/refs/heads/main/src/content/doc-sdk-javascript/data-types.mdx

0 commit comments

Comments
 (0)