www_docs_threefold_io/docs_website/docusaurus.config.ts

219 lines
5.3 KiB
TypeScript
Raw Normal View History

2024-08-24 12:53:09 +00:00
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';
const config: Config = {
title: 'ThreeFold',
2024-11-18 06:55:48 +00:00
tagline: 'Self-Healing Data & Cloud Network',
2024-11-20 17:29:12 +00:00
favicon: 'img/logo_official.svg',
2024-08-24 12:53:09 +00:00
// Set the production url of your site here
2024-11-13 18:30:42 +00:00
url: 'https://docs.projectmycelium.io',
2024-08-24 12:53:09 +00:00
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
2024-08-26 18:10:27 +00:00
baseUrl: '',
2024-08-24 12:53:09 +00:00
// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
2024-11-13 19:34:58 +00:00
organizationName: 'git.ourworld.tf/tfgrid', // Usually your GitHub org/user name.
projectName: 'www_docs_threefold_io', // Usually your repo name.
2024-08-24 12:53:09 +00:00
trailingSlash: false,
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},
presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
},
blog: {
showReadingTime: true,
feedOptions: {
type: ['rss', 'atom'],
xslt: true,
},
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
// Useful options to enforce blogging best practices
onInlineTags: 'warn',
onInlineAuthors: 'warn',
onUntruncatedBlogPosts: 'warn',
},
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],
markdown: {
mermaid: true,
},
themes: ['@docusaurus/theme-mermaid'],
2024-08-27 03:28:34 +00:00
scripts: [
{
src:
'/js/crisp.js',
async: false,
},
],
2024-08-24 12:53:09 +00:00
themeConfig: {
2024-08-28 15:05:01 +00:00
algolia: {
// The application ID provided by Algolia
appId: 'MOZ4II24U5',
// Public API key: it is safe to commit it
apiKey: 'c9ee6a2a3212b6bdcf453149f45c9114',
indexName: 'threefold',
},
2024-08-24 18:09:39 +00:00
colorMode: {
2024-11-20 16:56:53 +00:00
defaultMode: 'dark',
2024-11-20 17:29:12 +00:00
disableSwitch: true,
2024-08-24 18:09:39 +00:00
respectPrefersColorScheme: false,
},
2024-08-24 12:53:09 +00:00
// Replace with your project's social card
2024-08-24 16:54:32 +00:00
image: 'img/threefold-social-card.png',
2024-08-24 12:53:09 +00:00
navbar: {
title: 'ThreeFold',
2024-08-24 12:53:09 +00:00
logo: {
alt: 'ThreeFold Logo',
src: 'img/logo.svg',
2024-08-26 22:27:11 +00:00
srcDark: 'img/logo_dark.svg',
2024-08-24 12:53:09 +00:00
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Docs',
},
2024-08-24 18:09:39 +00:00
{
to: '/support',
label: 'Support',
position: 'left',
},
2024-08-25 19:48:04 +00:00
{
href: 'https://threefold.io',
label: 'ThreeFold.io',
2024-08-25 19:48:04 +00:00
position: 'right',
},
2024-08-24 12:53:09 +00:00
],
},
footer: {
style: 'dark',
links: [
{
2024-08-24 18:09:39 +00:00
title: 'Docs',
2024-08-24 12:53:09 +00:00
items: [
{
label: 'Introduction',
to: '/docs/introduction',
},
2024-08-24 12:53:09 +00:00
{
label: 'Litepaper',
2024-08-24 16:50:08 +00:00
to: '/docs/litepaper',
},
2024-11-18 07:16:18 +00:00
{
label: 'Roadmap',
to: '/docs/roadmap',
},
2024-08-24 16:50:08 +00:00
{
label: 'References',
to: '/docs/category/references',
},
2024-08-24 12:53:09 +00:00
],
},
{
title: 'Components',
2024-08-24 12:53:09 +00:00
items: [
{
label: 'Phones',
to: '/docs/phones',
},
2024-10-30 16:08:35 +00:00
{
label: 'Nodes',
2024-11-18 06:55:48 +00:00
to: '/docs/category/nodes',
2024-08-24 12:53:09 +00:00
},
2024-10-31 00:45:28 +00:00
{
label: 'Routers',
to: '/docs/routers',
2024-10-31 00:45:28 +00:00
},
2024-11-18 07:16:18 +00:00
{
label: 'Marketplace',
to: '/docs/category/marketplace',
},
2024-10-30 16:08:35 +00:00
],
},
{
title: 'Community',
items: [
2024-08-24 12:53:09 +00:00
{
label: 'Telegram',
href: 'https://t.me/threefold',
},
{
2024-08-24 16:50:08 +00:00
label: 'X',
href: 'https://x.com/threefold_io',
2024-08-24 12:53:09 +00:00
},
2024-10-30 16:08:35 +00:00
{
label: 'Forum',
href: 'https://forum.threefold.io',
},
2024-08-25 19:48:04 +00:00
{
label: 'Support',
to: '/support',
},
2024-08-24 12:53:09 +00:00
],
},
{
2024-08-24 18:09:39 +00:00
title: 'Links',
2024-08-24 12:53:09 +00:00
items: [
{
label: 'ThreeFold.io',
2024-08-24 13:31:05 +00:00
href: 'https://threefold.io',
2024-08-24 12:53:09 +00:00
},
2024-11-15 19:19:23 +00:00
{
2024-11-18 17:51:02 +00:00
label: 'Dashboard',
2024-11-15 19:19:23 +00:00
href: 'https://dashboard.grid.tf',
},
2024-08-24 12:53:09 +00:00
{
label: 'GitHub',
href: 'https://github.com/threefoldtech/home',
},
{
label: 'Gitea',
2024-11-20 16:58:09 +00:00
href: 'https://git.ourworld.tf',
},
2024-08-24 12:53:09 +00:00
],
},
],
copyright: `Copyright © ${new Date().getFullYear()} ThreeFold`,
2024-08-24 12:53:09 +00:00
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};
export default config;