Skip to content

Commit 4fb704f

Browse files
committed
docs(site): clearer left-nav hierarchy + clickable header title
Style section headers (Get started, Governance, …) as bold uppercase labels distinct from page links, highlight the active page, and make the "AgentFlow4J" header title navigate home like the logo. Also gate the social-cards plugin behind SOCIAL_CARDS so the site builds locally without Cairo.
1 parent 8906f6b commit 4fb704f

3 files changed

Lines changed: 53 additions & 0 deletions

File tree

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/* Make the header site title ("AgentFlow4J") clickable → home,
2+
mirroring the logo's per-page relative href. */
3+
document.addEventListener("DOMContentLoaded", function () {
4+
var title = document.querySelector(".md-header__title");
5+
var logo = document.querySelector(".md-header__button.md-logo");
6+
if (!title || !logo) return;
7+
8+
title.style.cursor = "pointer";
9+
title.addEventListener("click", function (e) {
10+
// leave genuinely interactive children (search, buttons) alone
11+
if (e.target.closest("a, button, input, label, .md-search")) return;
12+
var href = logo.getAttribute("href");
13+
if (href) window.location.href = href;
14+
});
15+
});

docs/stylesheets/extra.css

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
/* ---------------------------------------------------------------------------
2+
Left navigation — clear visual hierarchy between section headers and pages.
3+
4+
Section labels (Get started, Governance, …) are <label> elements rendered by
5+
`navigation.sections`; page links are <a> elements. Styling each by element
6+
type avoids any specificity conflict.
7+
--------------------------------------------------------------------------- */
8+
9+
/* Section headers: bold, uppercase, slightly LARGER than page links */
10+
.md-nav--primary .md-nav__item--section > label.md-nav__link,
11+
.md-nav--primary .md-nav__item--section > span.md-nav__link {
12+
font-size: 0.8rem;
13+
font-weight: 700;
14+
text-transform: uppercase;
15+
letter-spacing: 0.05em;
16+
color: var(--md-default-fg-color);
17+
margin-top: 1.1rem;
18+
margin-bottom: 0.2rem;
19+
cursor: default;
20+
}
21+
22+
/* Page links: normal weight + case, slightly smaller than Material default */
23+
.md-nav--primary a.md-nav__link {
24+
font-size: 0.76rem;
25+
}
26+
27+
/* Active page link: accent colour + medium weight = clear "you are here" */
28+
.md-nav--primary a.md-nav__link--active {
29+
font-weight: 600;
30+
color: var(--md-primary-fg-color);
31+
}

mkdocs.yml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ edit_uri: edit/main/docs/
99

1010
docs_dir: docs
1111

12+
extra_css:
13+
- stylesheets/extra.css
14+
15+
extra_javascript:
16+
- javascripts/header-home-link.js
17+
1218
theme:
1319
name: material
1420
language: en
@@ -92,6 +98,7 @@ nav:
9298
plugins:
9399
- search
94100
- social:
101+
enabled: !ENV [SOCIAL_CARDS, true] # set SOCIAL_CARDS=false for local preview without Cairo
95102
cards: true
96103
cards_layout_options:
97104
background_color: "#0f172a" # slate-900

0 commit comments

Comments
 (0)