Add banner to docs about offline access

Mechanical-Advantage · Sep 25, 2024 · 9cea8d1 · 9cea8d1
1 parent a40322c
commit 9cea8d1
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/docsSite/docusaurus-embed.config.ts b/docsSite/docusaurus-embed.config.ts
@@ -3,7 +3,10 @@ import config from "./docusaurus.config";
 const configEmbed = Object.assign(config, {
   future: {
     experimental_router: "hash"
-  }
+  },
+  themeConfig: Object.assign(config.themeConfig!, {
+    announcementBar: undefined
+  })
 });
 
 export default configEmbed;
diff --git a/docsSite/docusaurus.config.ts b/docsSite/docusaurus.config.ts
@@ -40,7 +40,6 @@ const config: Config = {
   ],
 
   themeConfig: {
-    // Replace with your project's social card
     image: "img/social.png",
     navbar: {
       title: "AdvantageScope Documentation",
@@ -65,6 +64,14 @@ const config: Config = {
       disableSwitch: true,
       respectPrefersColorScheme: true
     },
+    announcementBar: {
+      id: "offline_info",
+      content:
+        "This documentation is available <b>offline</b> by clicking the 📖 icon in the tab bar of AdvantageScope.",
+      backgroundColor: "#446ce3",
+      textColor: "#ffffff",
+      isCloseable: true
+    },
     prism: {
       theme: prismThemes.github,
       darkTheme: prismThemes.dracula,