Skip to content
This repository was archived by the owner on Aug 8, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
**/.vscode
.idea
*.log
node_modules
dist
node_modules
52 changes: 52 additions & 0 deletions docs/nav.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
function page(title, slug, path, props) {
return { type: "page", path, slug, title, ...props };
}
function section(title) {
return { type: "section", title };
}
const nav = {
items: [
section("Intro"),
page("Overview", "index", "Overview/index.md"),
page("Getting Started", "getting-started", "Getting Started/index.md"),
section("Deploying"),
page("Testnet", "deploying/testnet", "Cloud Testnet/index.md"),
section("Unity Tutorial"),
page("Part 1 - Basic Multiplayer", "unity/part-1", "Unity Tutorial/Part 1 - Basic Multiplayer.md"),
page("Part 2 - Resources And Scheduling", "unity/part-2", "Unity Tutorial/Part 2 - Resources And Scheduling.md"),
page("Part 3 - BitCraft Mini", "unity/part-3", "Unity Tutorial/Part 3 - BitCraft Mini.md"),
section("Server Module Languages"),
page("Overview", "modules", "Server Module Languages/index.md"),
page("Rust Quickstart", "modules/rust/quickstart", "Server Module Languages/Rust/index.md"),
page("Rust Reference", "modules/rust", "Server Module Languages/Rust/ModuleReference.md"),
page("C# Quickstart", "modules/c-sharp/quickstart", "Server Module Languages/C#/index.md"),
page("C# Reference", "modules/c-sharp", "Server Module Languages/C#/ModuleReference.md"),
section("Client SDK Languages"),
page("Overview", "sdks", "Client SDK Languages/index.md"),
page("Typescript Quickstart", "sdks/typescript/quickstart", "Client SDK Languages/Typescript/index.md"),
page("Typescript Reference", "sdks/typescript", "Client SDK Languages/Typescript/SDK Reference.md"),
page("Rust Quickstart", "sdks/rust/quickstart", "Client SDK Languages/Rust/index.md"),
page("Rust Reference", "sdks/rust", "Client SDK Languages/Rust/SDK Reference.md"),
page("Python Quickstart", "sdks/python/quickstart", "Client SDK Languages/Python/index.md"),
page("Python Reference", "sdks/python", "Client SDK Languages/Python/SDK Reference.md"),
page("C# Quickstart", "sdks/c-sharp/quickstart", "Client SDK Languages/C#/index.md"),
page("C# Reference", "sdks/c-sharp", "Client SDK Languages/C#/SDK Reference.md"),
section("WebAssembly ABI"),
page("Module ABI Reference", "webassembly-abi", "Module ABI Reference/index.md"),
section("HTTP API"),
page("HTTP", "http", "HTTP API Reference/index.md"),
page("`/identity`", "http/identity", "HTTP API Reference/Identities.md"),
page("`/database`", "http/database", "HTTP API Reference/Databases.md"),
page("`/energy`", "http/energy", "HTTP API Reference/Energy.md"),
section("WebSocket API Reference"),
page("WebSocket", "ws", "WebSocket API Reference/index.md"),
section("Data Format"),
page("SATN", "satn", "SATN Reference/index.md"),
page("BSATN", "bsatn", "SATN Reference/Binary Format.md"),
section("SQL"),
page("SQL Reference", "sql", "SQL Reference/index.md"),
],
};
exports.default = nav;
File renamed without changes.
15 changes: 15 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"name": "spacetime-docs",
"version": "1.0.0",
"description": "This repository contains the markdown files which are used to display documentation on our [website](https://spacetimedb.com/docs).",
"main": "index.js",
"dependencies": {},
"devDependencies": {
"typescript": "^5.3.2"
},
"scripts": {
"build": "tsc"
},
"author": "Clockwork Labs",
"license": "ISC"
}
8 changes: 8 additions & 0 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"compilerOptions": {
"target": "ESNext",
"module": "commonjs",
"outDir": "./docs",
"skipLibCheck": true
}
}
8 changes: 8 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY.
# yarn lockfile v1


typescript@^5.3.2:
version "5.3.2"
resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.3.2.tgz#00d1c7c1c46928c5845c1ee8d0cc2791031d4c43"
integrity sha512-6l+RyNy7oAHDfxC4FzSJcz9vnjTKxrLpDG5M2Vu4SHRVNg6xzqZp6LYSR9zjqQTu8DU/f5xwxUdADOkbrIX2gQ==