Skip to content

Commit 36d8425

Browse files
Add official Catalyst links and align theme
Add a single Official links page and wire website/explorer/faucet into navbar/footer and relevant guides. Update styling for a cleaner light-first look with optional dark mode. Made-with: Cursor
1 parent 4d2aa32 commit 36d8425

7 files changed

Lines changed: 111 additions & 17 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ npm run serve
4040
This repo is set up to build the site on every PR, and deploy `site/build/` to GitHub Pages on merges to `main`.
4141

4242
Notes:
43-
- For project pages, Docusaurus uses `baseUrl: "/catalyst-docs/"`.
44-
- The deployed URL will be the org GitHub Pages host + repo path (example: `https://catalyst-network.github.io/catalyst-docs/`).
43+
- For the current setup (custom domain), the site is served from the domain root:
44+
- `https://docs.catalystnet.org/`
45+
- If you host as a GitHub Pages **project site** instead, the site is served under `/<repo>/` and Docusaurus must use `baseUrl: "/catalyst-docs/"`.
4546

site/docs/explorer/user-guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ title: Explorer user guide
77

88
- The explorer URL for your network (public testnet or your operator’s explorer)
99

10+
Official public explorer:
11+
12+
- `https://explorer.catalystnet.org/`
13+
1014
## Steps
1115

1216
### 1) Look up a transaction

site/docs/faucet/user-guide.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@ The faucet is **testnet-only** and is intended to provide small amounts of KAT f
77

88
## You will need
99

10-
- Your address (EVM `address20`, `0x...`) as requested by the faucet UI/API
10+
- Your Catalyst **`pubkey32`** address (`0x` + 64 hex chars) as requested by the faucet UI/API
1111
- Access to the hosted faucet UI (or your operator’s faucet)
1212

13+
Official public faucet:
14+
15+
- `https://faucet.catalystnet.org/`
16+
1317
## Steps
1418

1519
### 1) Request funds via the UI

site/docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ sidebar_position: 1
66

77
This is the public documentation hub for the Catalyst ecosystem.
88

9+
Official links:
10+
11+
- **Website**: `https://catalystnet.org/`
12+
- **Explorer**: `https://explorer.catalystnet.org/`
13+
- **Faucet**: `https://faucet.catalystnet.org/`
14+
- **More**: see **[Official links](/docs/overview/official-links)**.
15+
916
## Choose your path
1017

1118
- **Everyday users**: start with **[Use cases (for everyone)](/docs/use-cases/send-money)** or **[Quickstart: use Catalyst apps](/docs/quickstarts/i-want-to-use-apps)**.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
sidebar_position: 0
3+
title: Official links
4+
---
5+
6+
Use these links consistently across the docs (and prefer them over “random” mirrors).
7+
8+
## Website
9+
10+
- `https://catalystnet.org/`
11+
12+
## Explorer (public testnet)
13+
14+
- `https://explorer.catalystnet.org/`
15+
16+
## Faucet (public testnet)
17+
18+
- `https://faucet.catalystnet.org/`
19+
20+
## App downloads (coming soon)
21+
22+
Add these once the pages exist:
23+
24+
- **iOS App Store**: (TBD)
25+
- **Google Play**: (TBD)
26+
- **Chrome Web Store**: (TBD)
27+
- **Catalyst app store**: (TBD)
28+

site/docusaurus.config.ts

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,13 @@ const config: Config = {
1010
title: 'Catalyst Docs',
1111
tagline: 'Operators, wallets, builders, and protocol/RPC reference.',
1212
favicon: 'img/favicon.ico',
13+
customFields: {
14+
links: {
15+
website: 'https://catalystnet.org/',
16+
explorer: 'https://explorer.catalystnet.org/',
17+
faucet: 'https://faucet.catalystnet.org/',
18+
},
19+
},
1320

1421
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
1522
future: {
@@ -76,6 +83,8 @@ const config: Config = {
7683
themeConfig: {
7784
image: 'img/docusaurus-social-card.jpg',
7885
colorMode: {
86+
defaultMode: 'light',
87+
disableSwitch: false,
7988
respectPrefersColorScheme: true,
8089
},
8190
navbar: {
@@ -91,6 +100,30 @@ const config: Config = {
91100
position: 'left',
92101
label: 'Docs',
93102
},
103+
{
104+
to: '/docs/overview/official-links',
105+
label: 'Links',
106+
position: 'left',
107+
},
108+
{
109+
type: 'search',
110+
position: 'right',
111+
},
112+
{
113+
href: 'https://catalystnet.org/',
114+
label: 'Website',
115+
position: 'right',
116+
},
117+
{
118+
href: 'https://explorer.catalystnet.org/',
119+
label: 'Explorer',
120+
position: 'right',
121+
},
122+
{
123+
href: 'https://faucet.catalystnet.org/',
124+
label: 'Faucet',
125+
position: 'right',
126+
},
94127
{
95128
href: 'https://github.com/catalyst-network/catalyst-docs',
96129
label: 'GitHub',
@@ -101,6 +134,14 @@ const config: Config = {
101134
footer: {
102135
style: 'dark',
103136
links: [
137+
{
138+
title: 'Catalyst',
139+
items: [
140+
{ label: 'Website', href: 'https://catalystnet.org/' },
141+
{ label: 'Explorer', href: 'https://explorer.catalystnet.org/' },
142+
{ label: 'Faucet', href: 'https://faucet.catalystnet.org/' },
143+
],
144+
},
104145
{
105146
title: 'Docs',
106147
items: [

site/src/css/custom.css

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,34 @@
66

77
/* You can override the default Infima variables here. */
88
:root {
9-
--ifm-color-primary: #2e8555;
10-
--ifm-color-primary-dark: #29784c;
11-
--ifm-color-primary-darker: #277148;
12-
--ifm-color-primary-darkest: #205d3b;
13-
--ifm-color-primary-light: #33925d;
14-
--ifm-color-primary-lighter: #359962;
15-
--ifm-color-primary-lightest: #3cad6e;
9+
/* Brand-ish neutral blue accent (easy on white backgrounds). */
10+
--ifm-color-primary: #2563eb;
11+
--ifm-color-primary-dark: #1d4ed8;
12+
--ifm-color-primary-darker: #1e40af;
13+
--ifm-color-primary-darkest: #1e3a8a;
14+
--ifm-color-primary-light: #3b82f6;
15+
--ifm-color-primary-lighter: #60a5fa;
16+
--ifm-color-primary-lightest: #93c5fd;
17+
18+
--ifm-font-family-base: ui-sans-serif, system-ui, -apple-system, Segoe UI, Roboto, Helvetica,
19+
Arial, "Apple Color Emoji", "Segoe UI Emoji";
1620
--ifm-code-font-size: 95%;
1721
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
1822
}
1923

2024
/* For readability concerns, you should choose a lighter palette in dark mode. */
2125
[data-theme='dark'] {
22-
--ifm-color-primary: #25c2a0;
23-
--ifm-color-primary-dark: #21af90;
24-
--ifm-color-primary-darker: #1fa588;
25-
--ifm-color-primary-darkest: #1a8870;
26-
--ifm-color-primary-light: #29d5b0;
27-
--ifm-color-primary-lighter: #32d8b4;
28-
--ifm-color-primary-lightest: #4fddbf;
26+
--ifm-color-primary: #60a5fa;
27+
--ifm-color-primary-dark: #3b82f6;
28+
--ifm-color-primary-darker: #2563eb;
29+
--ifm-color-primary-darkest: #1d4ed8;
30+
--ifm-color-primary-light: #93c5fd;
31+
--ifm-color-primary-lighter: #bfdbfe;
32+
--ifm-color-primary-lightest: #dbeafe;
2933
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
3034
}
35+
36+
/* Subtle “product” feel: crisp header, white background. */
37+
.navbar {
38+
border-bottom: 1px solid var(--ifm-toc-border-color);
39+
}

0 commit comments

Comments
 (0)