docs: A number of UI changes for Docusaurus (#1366)

* A number of minor ui changes * Update docs/docusaurus.config.js Co-authored-by: MSalopek <[email protected]> * Update docs/docusaurus.config.js Co-authored-by: MSalopek <[email protected]> * Reverted some changes based on review comments * chore: add math formula deps * fix: rm underline on title cards; update highlight bg and font color * Added missing acorns * docs: rm curly braces from ADR template * docs: fix warnings; fix errs; use min-h-screen for content --------- Co-authored-by: MSalopek <[email protected]>
cosmos · Dec 5, 2023 · 583d178 · 583d178
1 parent d2e82f1
commit 583d178
Show file tree

Hide file tree

Showing 9 changed files with 324 additions and 43 deletions.
diff --git a/docs/docs/adrs/adr-004-denom-dos-fixes → docs/docs/adrs/adr-004-denom-dos-fixes.md b/docs/docs/adrs/adr-004-denom-dos-fixes → docs/docs/adrs/adr-004-denom-dos-fixes.md
diff --git a/docs/docs/adrs/adr-template.md b/docs/docs/adrs/adr-template.md
@@ -2,16 +2,16 @@
 sidebar_position: 2
 title: ADR Template
 ---
-# ADR {ADR-NUMBER}: {TITLE}
+# ADR [ADR-NUMBER]: [TITLE]
 
 ## Changelog
-* {date}: {changelog}
+* [date]: [changelog]
 
 ## Status
 
 > A decision may be "proposed" if it hasn't been agreed upon yet, or "accepted" once it is agreed upon. If a later ADR changes or reverses a decision, it may be marked as "deprecated" or "superseded" with a reference to its replacement.
 
-{Deprecated|Proposed|Accepted}
+[Deprecated|Proposed|Accepted]
 
 ## Context
 
@@ -38,4 +38,4 @@ If the proposed change will be large, please also indicate a way to do the chang
 
 > Are there any relevant PR comments, issues that led up to this, or articles referenced for why we made the given design choice? If so link them here!
 
-* {reference link}
+* [references]
diff --git a/docs/docs/adrs/intro.md b/docs/docs/adrs/intro.md
@@ -34,7 +34,7 @@ To suggest an ADR, please make use of the [ADR template](./adr-template.md) prov
 
 - [ADR 001: Key Assignment](./adr-001-key-assignment.md)
 - [ADR 002: Jail Throttling](./adr-002-throttle.md)
-- [ADR 004: Denom DOS fixes](./adr-004-denom-dos-fixes)
+- [ADR 004: Denom DOS fixes](./adr-004-denom-dos-fixes.md)
 - [ADR 005: Cryptographic verification of equivocation evidence](./adr-005-cryptographic-equivocation-verification.md)
 - [ADR 008: Throttle with retries](./adr-008-throttle-retries.md)
 - [ADR 009: Soft Opt-Out](./adr-009-soft-opt-out.md)

diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
@@ -1,8 +1,10 @@
 // @ts-check
 // Note: type annotations allow type checking and IDEs autocompletion
+import remarkMath from "remark-math";
+import rehypeKatex from "rehype-katex";
 
-const lightCodeTheme = require('prism-react-renderer').themes.github;
-const darkCodeTheme = require('prism-react-renderer').themes.dracula;
+const lightCodeTheme = require("prism-react-renderer").themes.github;
+const darkCodeTheme = require("prism-react-renderer").themes.dracula;
 
 /** @type {import('@docusaurus/types').Config} */
 const config = {
@@ -35,14 +37,16 @@ const config = {
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
-          sidebarPath: require.resolve('./sidebars.js'),
+          sidebarPath: require.resolve("./sidebars.js"),
           routeBasePath: "/",
           versions: {
             current: {
               path: "/",
               // banner: "current",
             },
           },
+          remarkPlugins: [remarkMath],
+          rehypePlugins: [rehypeKatex],
         },
 
         theme: {
@@ -62,19 +66,19 @@ const config = {
         },
       },
       colorMode: {
-        defaultMode: 'dark',
-        disableSwitch: true,
+        defaultMode: "dark",
+        disableSwitch: false,
         respectPrefersColorScheme: false,
       },
       navbar: {
         title: "Interchain Security",
         hideOnScroll: false,
-        // logo: {
-        //   alt: "Interchain Security Logo",
-        //   src: "img/logo-sdk.svg",
-        //   href: "/",
-        //   target: "_self",
-        // },
+        logo: {
+          alt: "Interchain Security Logo",
+          src: "/img/hub.svg",
+          href: "/",
+          target: "_self",
+        },
         items: [
           {
             href: "https://github.com/cosmos/interchain-security",
@@ -96,7 +100,7 @@ const config = {
           {
             items: [
               {
-                html: `<a href="https://cosmos.network"><img src="/img/logo-bw.svg" alt="Cosmos Logo"></a>`,
+                html: `<a href="https://cosmos.network"><img src="/interchain-security/img/logo-bw.svg" alt="Interchain Security Logo"></a>`,
               },
             ],
           },
@@ -164,7 +168,8 @@ const config = {
             ],
           },
         ],
-        copyright: "Informal Systems",
+        copyright:
+          "The development of Interchain Security is primarily led by Informal Systems. Funding for this development comes primarily from the Interchain Foundation, a Swiss non-profit.",
       },
       prism: {
         theme: lightCodeTheme,
@@ -206,7 +211,7 @@ const config = {
         toExtensions: ["html"],
         redirects: [
           {
-            from: ["/", "/main", "/master"],
+            from: ["/main", "/master"],
             to: "/",
           },
         ],