|
|
|
export const SITE = {
|
|
|
|
title: "NextGraph Docs",
|
|
|
|
description: "NextGraph Documentation",
|
|
|
|
defaultLanguage: "en_US",
|
|
|
|
};
|
|
|
|
|
|
|
|
export const OPEN_GRAPH = {
|
|
|
|
image: {
|
|
|
|
src: "https://docs.nextgraph.org/public/logo-text.png",
|
|
|
|
alt: "NextGraph logo",
|
|
|
|
},
|
|
|
|
twitter: "nextgraph",
|
|
|
|
};
|
|
|
|
|
|
|
|
// This is the type of the frontmatter you put in the docs markdown files.
|
|
|
|
export type Frontmatter = {
|
|
|
|
title: string;
|
|
|
|
description: string;
|
|
|
|
layout: string;
|
|
|
|
image?: { src: string; alt: string };
|
|
|
|
dir?: "ltr" | "rtl";
|
|
|
|
ogLocale?: string;
|
|
|
|
lang?: string;
|
|
|
|
};
|
|
|
|
|
|
|
|
export const KNOWN_LANGUAGES = {
|
|
|
|
English: "en",
|
|
|
|
} as const;
|
|
|
|
export const KNOWN_LANGUAGE_CODES = Object.values(KNOWN_LANGUAGES);
|
|
|
|
|
|
|
|
export const GITHUB_EDIT_URL = `https://git.nextgraph.org/NextGraph/docs-site/src/branch/master`;
|
|
|
|
|
|
|
|
export const COMMUNITY_INVITE_URL = `https://forum.nextgraph.org`;
|
|
|
|
|
|
|
|
// See "Algolia" section of the README for more information.
|
|
|
|
export const ALGOLIA = {
|
|
|
|
indexName: "docs",
|
|
|
|
appId: "XXXXXXXXXX",
|
|
|
|
apiKey: "08IMxBGqKrHJTIoq1dHfmaw9MSeLetwfLbuRvQuXZAZFWckX",
|
|
|
|
};
|
|
|
|
|
|
|
|
export type Sidebar = Record<
|
|
|
|
typeof KNOWN_LANGUAGE_CODES[number],
|
|
|
|
Record<string, { text: string; link: string }[]>
|
|
|
|
>;
|
|
|
|
export const SIDEBAR: Sidebar = {
|
|
|
|
en: {
|
|
|
|
"App & Platform": [
|
|
|
|
{ text: "Introduction", link: "en/introduction" },
|
|
|
|
{ text: "Getting started", link: "en/getting-started" },
|
|
|
|
{ text: "Local-First", link: "en/local-first" },
|
|
|
|
{ text: "Encryption", link: "en/encryption" },
|
|
|
|
{ text: "Wallet", link: "en/wallet" },
|
|
|
|
{ text: "Documents and Stores", link: "en/documents" },
|
|
|
|
{ text: "Social Network", link: "en/social-network" },
|
|
|
|
{ text: "Collaborative tools", link: "en/collaboration" },
|
|
|
|
{ text: "Features", link: "en/features" },
|
|
|
|
{ text: "Self-Hosted", link: "en/self-hosted" },
|
|
|
|
{ text: "Help / FAQ", link: "en/help" },
|
|
|
|
{ text: "Accessibility", link: "en/accessibility" },
|
|
|
|
{ text: "Roadmap", link: "en/roadmap" },
|
|
|
|
],
|
|
|
|
Framework: [
|
|
|
|
{ text: "Introduction", link: "en/framework" },
|
|
|
|
{ text: "Getting started", link: "en/framework/getting-started" },
|
|
|
|
{ text: "Data-First", link: "en/framework/data-first" },
|
|
|
|
{ text: "CRDTs", link: "en/framework/crdts" },
|
|
|
|
{ text: "Semantic Web", link: "en/framework/semantic" },
|
|
|
|
{ text: "Schema", link: "en/framework/schema" },
|
|
|
|
{ text: "DID & Nuri", link: "en/framework/nuri" },
|
|
|
|
{ text: "Transactions", link: "en/framework/transactions" },
|
|
|
|
{ text: "Permissions", link: "en/framework/permissions" },
|
|
|
|
{ text: "Signature", link: "en/framework/signature" },
|
|
|
|
{ text: "Smart-contract", link: "en/framework/smart-contract" },
|
|
|
|
{ text: "Services", link: "en/framework/services" },
|
|
|
|
{ text: "Ecosystem", link: "en/ecosystem" },
|
|
|
|
{ text: "ActivityPub", link: "en/activitypub" },
|
|
|
|
{ text: "Solid", link: "en/solid" },
|
|
|
|
{ text: "Roadmap", link: "en/framework/roadmap" },
|
|
|
|
],
|
|
|
|
Design: [
|
|
|
|
{ text: "Overview", link: "en/design" },
|
|
|
|
{ text: "Architecture", link: "en/architecture" },
|
|
|
|
{ text: "Network", link: "en/network" },
|
|
|
|
{ text: "Sync Protocol", link: "en/protocol" },
|
|
|
|
{ text: "Verifier", link: "en/verifier" },
|
|
|
|
{ text: "Specifications", link: "en/specs" },
|
|
|
|
{ text: "Security Audit", link: "en/audit" },
|
|
|
|
{ text: "Survey", link: "en/survey" },
|
|
|
|
],
|
|
|
|
Reference: [
|
|
|
|
{ text: "Web JS SDK", link: "en/web" },
|
|
|
|
{ text: "NodeJS SDK", link: "en/nodejs" },
|
|
|
|
{ text: "Rust SDK", link: "en/rust" },
|
|
|
|
{ text: "Broker ngd", link: "en/ngd" },
|
|
|
|
{ text: "CLI", link: "en/cli" },
|
|
|
|
{ text: "Core protocol", link: "en/specs/protocol-core" },
|
|
|
|
{ text: "Client protocol", link: "en/specs/protocol-client" },
|
|
|
|
{ text: "App protocol", link: "en/specs/protocol-app" },
|
|
|
|
{ text: "Ext protocol", link: "en/specs/protocol-ext" },
|
|
|
|
{ text: "Admin protocol", link: "en/specs/protocol-admin" },
|
|
|
|
{ text: "Repo format", link: "en/specs/format-repo" },
|
|
|
|
{ text: "Wallet format", link: "en/specs/format-wallet" },
|
|
|
|
{ text: "DID method", link: "en/specs/did" },
|
|
|
|
],
|
|
|
|
},
|
|
|
|
};
|