Documentation site of NextGraph.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
docs-site/src/config.ts

108 lines
4.0 KiB

2 years ago
export const SITE = {
2 years ago
title: "NextGraph Docs",
description: "NextGraph Documentation",
defaultLanguage: "en_US",
2 years ago
};
export const OPEN_GRAPH = {
2 years ago
image: {
src: "https://docs.nextgraph.org/public/logo-text.png",
6 months ago
alt: "NextGraph logo",
2 years ago
},
twitter: "nextgraph",
2 years ago
};
// This is the type of the frontmatter you put in the docs markdown files.
export type Frontmatter = {
2 years ago
title: string;
description: string;
layout: string;
image?: { src: string; alt: string };
dir?: "ltr" | "rtl";
ogLocale?: string;
lang?: string;
2 years ago
};
export const KNOWN_LANGUAGES = {
2 years ago
English: "en",
2 years ago
} 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`;
2 years ago
export const COMMUNITY_INVITE_URL = `https://forum.nextgraph.org`;
// See "Algolia" section of the README for more information.
export const ALGOLIA = {
2 years ago
indexName: "docs",
appId: "XXXXXXXXXX",
apiKey: "08IMxBGqKrHJTIoq1dHfmaw9MSeLetwfLbuRvQuXZAZFWckX",
2 years ago
};
export type Sidebar = Record<
2 years ago
typeof KNOWN_LANGUAGE_CODES[number],
Record<string, { text: string; link: string }[]>
2 years ago
>;
export const SIDEBAR: Sidebar = {
2 years ago
en: {
"App & Platform": [
2 years ago
{ 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" },
2 years ago
{ text: "Help / FAQ", link: "en/help" },
{ text: "Accessibility", link: "en/accessibility" },
{ text: "Roadmap", link: "en/roadmap" },
],
2 months ago
Framework: [
{ text: "Introduction", link: "en/framework" },
{ text: "Getting started", link: "en/framework/getting-started" },
2 months ago
{ 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" },
2 months ago
{ text: "DID & Nuri", link: "en/framework/nuri" },
{ text: "Transactions", link: "en/framework/transactions" },
{ text: "Permissions", link: "en/framework/permissions" },
2 months ago
{ text: "Signature", link: "en/framework/signature" },
{ text: "Smart-contract", link: "en/framework/smart-contract" },
2 months ago
{ 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" },
2 years ago
],
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" },
2 years ago
{ text: "Specifications", link: "en/specs" },
{ text: "Security Audit", link: "en/audit" },
{ text: "Survey", link: "en/survey" },
],
2 months ago
Reference: [
{ text: "NodeJS SDK", link: "en/nodejs" },
{ text: "Web JS SDK", link: "en/web" },
{ 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" },
2 years ago
],
},
2 years ago
};