From 77f92aa4ada872cd14d9a0fd6d91043f010da22b Mon Sep 17 00:00:00 2001 From: mik-tf Date: Fri, 7 Feb 2025 14:00:54 -0500 Subject: [PATCH] add new cfg version --- cfg/footer.json | 69 ++++++++++++++ cfg/main.json | 15 ++++ cfg/navbar.json | 21 +++++ docusaurus.config.ts | 131 +++++---------------------- docusaurus.config.ts.archive | 169 +++++++++++++++++++++++++++++++++++ 5 files changed, 296 insertions(+), 109 deletions(-) create mode 100644 cfg/footer.json create mode 100644 cfg/main.json create mode 100644 cfg/navbar.json create mode 100644 docusaurus.config.ts.archive diff --git a/cfg/footer.json b/cfg/footer.json new file mode 100644 index 0000000..291628d --- /dev/null +++ b/cfg/footer.json @@ -0,0 +1,69 @@ +{ + "style": "dark", + "links": [ + { + "title": "DePIN", + "items": [ + { + "label": "Introduction", + "href": "/docs/introduction" + }, + { + "label": "BYO Internet", + "href": "/docs/byoi" + }, + { + "label": "TFGrid POC", + "href": "/docs/threefold_poc" + }, + { + "label": "Feedback", + "to": "/docs/feedback" + } + ] + }, + { + "title": "Community", + "items": [ + { + "label": "Telegram", + "href": "https://t.me/threefold" + }, + { + "label": "X", + "href": "https://x.com/threefold_io" + }, + { + "label": "Forum", + "href": "https://forum.threefold.io" + }, + { + "label": "Support", + "to": "/support" + } + ] + }, + { + "title": "Links", + "items": [ + { + "label": "ThreeFold.io", + "href": "https://threefold.io" + }, + { + "label": "Dashboard", + "href": "https://dashboard.grid.tf" + }, + { + "label": "GitHub", + "href": "https://github.com/threefoldtech/home" + }, + { + "label": "Gitea", + "href": "https://git.ourworld.tf/tfgrid/info_docs_byoi" + } + ] + } + ], + "copyright": "Copyright © 2025 ThreeFold" +} \ No newline at end of file diff --git a/cfg/main.json b/cfg/main.json new file mode 100644 index 0000000..46ae1b4 --- /dev/null +++ b/cfg/main.json @@ -0,0 +1,15 @@ +{ + "title": "Build Your Own Internet", + "tagline": "Learn how to build your own internet", + "favicon": "img/favicon.png", + "url": "https://threefold.info", + "baseUrl": "/byoi/", + "image": "img/tf_graph.png", + "metadata": { + "description": "Learn how to build your own internet", + "image": "https://info.ourworld.tf/img/tf_graph.png", + "title": "Build Your Own Internet" + }, + "buildDest": "root@info.ourworld.tf:/root/hero/www/info", + "buildDestDev": "root@info.ourworld.tf:/root/hero/www/infodev" +} \ No newline at end of file diff --git a/cfg/navbar.json b/cfg/navbar.json new file mode 100644 index 0000000..d3233f0 --- /dev/null +++ b/cfg/navbar.json @@ -0,0 +1,21 @@ +{ + "title": "", + "items": [ + { + "type": "docSidebar", + "sidebarId": "tutorialSidebar", + "position": "left", + "label": "Docs" + }, + { + "to": "/support", + "label": "Support", + "position": "left" + }, + { + "href": "https://threefold.io", + "label": "ThreeFold.io", + "position": "right" + } + ] +} \ No newline at end of file diff --git a/docusaurus.config.ts b/docusaurus.config.ts index 6c68eaa..059ec87 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -1,14 +1,17 @@ import {themes as prismThemes} from 'prism-react-renderer'; import type {Config} from '@docusaurus/types'; import type * as Preset from '@docusaurus/preset-classic'; +import navbar from './cfg/navbar.json'; +import footer from './cfg/footer.json'; +import main from './cfg/main.json'; const config: Config = { - title: 'Build Your Own Internet', - tagline: 'Learn how to build your own internet', - favicon: 'img/favicon.png', + title: main.title, + tagline: main.tagline, + favicon: main.favicon, - url: 'https://threefold.info', - baseUrl: '/byoi/', + url: main.url, + baseUrl: main.baseUrl, onBrokenLinks: 'throw', onBrokenMarkdownLinks: 'warn', @@ -48,122 +51,32 @@ const config: Config = { themes: ['@docusaurus/theme-mermaid'], scripts: [ - { - src: - '/js/crisp.js', + src: '/js/crisp.js', async: false, }, ], themeConfig: { - colorMode: { - defaultMode: 'dark', + defaultMode: "dark", disableSwitch: true, - respectPrefersColorScheme: false, - }, - image: 'img/tf_graph.png', - navbar: { - title: '', - logo: { - alt: 'ThreeFold Logo', - src: 'img/logo.svg', - srcDark: 'img/new_logo_tft.png', - }, - items: [ - { - type: 'docSidebar', - sidebarId: 'tutorialSidebar', - position: 'left', - label: 'Docs', - }, - { - to: '/support', - label: 'Support', - position: 'left', - }, - { - href: 'https://threefold.io', - label: 'ThreeFold.io', - position: 'right', - }, - ], - }, - footer: { - style: 'dark', - links: [ - { - title: 'DePIN', - items: [ - { - label: 'Introduction', - href: '/docs/introduction', - }, - { - label: 'BYO Internet', - href: '/docs/byoi', - }, - { - label: 'TFGrid POC', - href: '/docs/threefold_poc', - }, - { - label: 'Feedback', - to: '/docs/feedback', - }, - ], - }, - { - title: 'Community', - items: [ - { - label: 'Telegram', - href: 'https://t.me/threefold', - }, - { - label: 'X', - href: 'https://x.com/threefold_io', - }, - { - label: 'Forum', - href: 'https://forum.threefold.io', - }, - { - label: 'Support', - to: '/support', - }, - ], - }, - { - title: 'Links', - items: [ - { - label: 'ThreeFold.io', - href: 'https://threefold.io', - }, - { - label: 'Dashboard', - href: 'https://dashboard.grid.tf', - }, - { - label: 'GitHub', - href: 'https://github.com/threefoldtech/home', - }, - { - label: 'Gitea', - href: 'https://git.ourworld.tf/tfgrid/info_docs_byoi', - }, - ], - }, - ], - copyright: `Copyright © ${new Date().getFullYear()} ThreeFold`, + respectPrefersColorScheme: false }, + image: main.image, + metadata: [ + { name: 'description', content: main.metadata.description }, + { property: 'og:image', content: main.metadata.image }, + { property: 'og:description', content: main.metadata.description }, + { property: 'og:title', content: main.metadata.title }, + ], + navbar: navbar, + footer: footer, prism: { theme: prismThemes.github, darkTheme: prismThemes.dracula, }, - } satisfies Preset.ThemeConfig, + }, }; -export default config; \ No newline at end of file +export default config; diff --git a/docusaurus.config.ts.archive b/docusaurus.config.ts.archive new file mode 100644 index 0000000..6c68eaa --- /dev/null +++ b/docusaurus.config.ts.archive @@ -0,0 +1,169 @@ +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: 'Build Your Own Internet', + tagline: 'Learn how to build your own internet', + favicon: 'img/favicon.png', + + url: 'https://threefold.info', + baseUrl: '/byoi/', + + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', + + i18n: { + defaultLocale: 'en', + locales: ['en'], + }, + + presets: [ + [ + 'classic', + { + docs: { + sidebarPath: './sidebars.ts', + }, + blog: { + showReadingTime: true, + feedOptions: { + type: ['rss', 'atom'], + xslt: true, + }, + onInlineTags: 'warn', + onInlineAuthors: 'warn', + onUntruncatedBlogPosts: 'warn', + }, + theme: { + customCss: './src/css/custom.css', + }, + } satisfies Preset.Options, + ], + ], + + markdown: { + mermaid: true, + }, + themes: ['@docusaurus/theme-mermaid'], + + scripts: [ + + { + src: + '/js/crisp.js', + async: false, + }, + ], + + themeConfig: { + + colorMode: { + defaultMode: 'dark', + disableSwitch: true, + respectPrefersColorScheme: false, + }, + image: 'img/tf_graph.png', + navbar: { + title: '', + logo: { + alt: 'ThreeFold Logo', + src: 'img/logo.svg', + srcDark: 'img/new_logo_tft.png', + }, + items: [ + { + type: 'docSidebar', + sidebarId: 'tutorialSidebar', + position: 'left', + label: 'Docs', + }, + { + to: '/support', + label: 'Support', + position: 'left', + }, + { + href: 'https://threefold.io', + label: 'ThreeFold.io', + position: 'right', + }, + ], + }, + footer: { + style: 'dark', + links: [ + { + title: 'DePIN', + items: [ + { + label: 'Introduction', + href: '/docs/introduction', + }, + { + label: 'BYO Internet', + href: '/docs/byoi', + }, + { + label: 'TFGrid POC', + href: '/docs/threefold_poc', + }, + { + label: 'Feedback', + to: '/docs/feedback', + }, + ], + }, + { + title: 'Community', + items: [ + { + label: 'Telegram', + href: 'https://t.me/threefold', + }, + { + label: 'X', + href: 'https://x.com/threefold_io', + }, + { + label: 'Forum', + href: 'https://forum.threefold.io', + }, + { + label: 'Support', + to: '/support', + }, + ], + }, + { + title: 'Links', + items: [ + { + label: 'ThreeFold.io', + href: 'https://threefold.io', + }, + { + label: 'Dashboard', + href: 'https://dashboard.grid.tf', + }, + { + label: 'GitHub', + href: 'https://github.com/threefoldtech/home', + }, + { + label: 'Gitea', + href: 'https://git.ourworld.tf/tfgrid/info_docs_byoi', + }, + ], + }, + ], + copyright: `Copyright © ${new Date().getFullYear()} ThreeFold`, + }, + prism: { + theme: prismThemes.github, + darkTheme: prismThemes.dracula, + }, + } satisfies Preset.ThemeConfig, +}; + +export default config; \ No newline at end of file -- 2.40.1