Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: A number of UI changes for Docusaurus #1366

Merged
merged 11 commits into from
Dec 5, 2023
2 changes: 1 addition & 1 deletion docs/docs/adrs/adr-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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}
* \{reference link}
31 changes: 18 additions & 13 deletions docs/docusaurus.config.js
Original file line number Diff line number Diff line change
@@ -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 = {
Expand Down Expand Up @@ -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: {
Expand All @@ -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",
Expand All @@ -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>`,
},
],
},
Expand Down Expand Up @@ -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,
Expand Down
238 changes: 238 additions & 0 deletions docs/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading