Skip to content

Commit

Permalink
style: improve docs links, toc and icons (#1516)
Browse files Browse the repository at this point in the history
Last polish docs website design by:

- Limiting ToC height and allowing scroll inside (cf #1513)
- Replacing external icon
- Adding the full logo
- Improving the caret icon
- Fixing Toc hover color on dark mode

---------

Co-authored-by: Morgan <git@howl.moe>
  • Loading branch information
alexiscolin and thehowl authored Jan 10, 2024
1 parent 4bf9059 commit 26ad8dd
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 27 deletions.
5 changes: 2 additions & 3 deletions misc/docusaurus/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -45,11 +45,10 @@ const config = {
({
navbar: {
hideOnScroll: true,
title: "Gno.land",
logo: {
alt: "Gno.land Logo",
src: "img/logo.svg",
srcDark: "img/logo_light.svg",
src: "img/gnoland.svg",
srcDark: "img/gnoland_light.svg",
},
items: [
{
Expand Down
46 changes: 46 additions & 0 deletions misc/docusaurus/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,14 @@
--ifm-color-secondary: var(--ifm-color-primary-light);
--ifm-color-white: var(--ifm-color-primary);

--ifm-menu-link-sublist-icon: url("data:image/svg+xml;base64,PHN2ZyB3aWR0aD0iMjQiIGhlaWdodD0iMjQiIHZpZXdCb3g9IjAgMCAyNCAyNCIgZmlsbD0ibm9uZSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KPHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBjbGlwLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0zLjk2OTY3IDE1LjUzMDNDMy42NzY3OCAxNS4yMzc0IDMuNjc2NzggMTQuNzYyNiAzLjk2OTY3IDE0LjQ2OTdMMTEuNDY5NyA2Ljk2OTY3QzExLjc2MjYgNi42NzY3OCAxMi4yMzc0IDYuNjc2NzggMTIuNTMwMyA2Ljk2OTY3TDIwLjAzMDMgMTQuNDY5N0MyMC4zMjMyIDE0Ljc2MjYgMjAuMzIzMiAxNS4yMzc0IDIwLjAzMDMgMTUuNTMwM0MxOS43Mzc0IDE1LjgyMzIgMTkuMjYyNiAxNS44MjMyIDE4Ljk2OTcgMTUuNTMwM0wxMiA4LjU2MDY2TDUuMDMwMzMgMTUuNTMwM0M0LjczNzQ0IDE1LjgyMzIgNC4yNjI1NiAxNS44MjMyIDMuOTY5NjcgMTUuNTMwM1oiIGZpbGw9IiMxQzFDMUMiLz4KPC9zdmc+Cg==");
--content-max-w: 50rem;
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme="dark"]:root {
--ifm-color-primary: white;
--ifm-color-content-secondary: #a8a8a8;
--ifm-color-primary-dark: #282828;
--ifm-color-primary-darker: #1c1c1c;
--ifm-color-primary-light: #a8a8a8;
Expand Down Expand Up @@ -224,6 +226,10 @@ pre code {
color: var(--ifm-color-primary);
}

.menu__link--sublist-caret:after {
background: var(--ifm-menu-link-sublist-icon) 50% / 1.28rem 1.28rem;
}

/* Breadcrumb */
.breadcrumbs__item--active .breadcrumbs__link {
background-color: var(--ifm-navbar-background-color);
Expand All @@ -235,10 +241,38 @@ pre code {
overflow-y: inherit !important;
}
.table-of-contents {
position: relative;
background-color: var(--ifm-toc-background-color);
border-radius: 1rem;
border: none !important;
box-shadow: var(--ring-offset-shadow, 0 0 #0000), var(--ring-shadow, 0 0 #0000), var(--shadow);
max-height: calc(100vh - 10rem);
overflow: scroll;
-ms-overflow-style: none; /* IE and Edge */
scrollbar-width: none; /* Firefox */
}
.table-of-contents::-webkit-scrollbar {
display: none;
}

.theme-doc-toc-desktop::after {
content: "";
position: absolute;
bottom: 0;
left: 0;
width: 100%;
height: 2.5ch;
border-radius: 1rem;
background: linear-gradient(0deg, var(--ifm-toc-background-color) 0%, transparent);
pointer-events: none;
}

.table-of-contents__link:hover,
.table-of-contents__link:hover code,
.table-of-contents__link--active,
.table-of-contents__link--active code {
color: var(--ifm-color-primary);
text-decoration: none;
}

/* Footer */
Expand All @@ -249,6 +283,18 @@ pre code {
padding-inline: 0.5rem;
}

a.footer__link-item:after {
content: "↗";
font-size: 0.9em;
display: inline-block;
vertical-align: top;
padding-inline-start: 0.2em;
padding-block-start: 0.2;
}
a.footer__link-item > svg {
display: none;
}

.footer .container {
max-width: 100%;
}
Expand Down
3 changes: 3 additions & 0 deletions misc/docusaurus/static/img/gnoland.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions misc/docusaurus/static/img/gnoland_light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 0 additions & 12 deletions misc/docusaurus/static/img/logo.svg

This file was deleted.

12 changes: 0 additions & 12 deletions misc/docusaurus/static/img/logo_light.svg

This file was deleted.

0 comments on commit 26ad8dd

Please sign in to comment.