Skip to content

Commit 5f98927

Browse files
committed
docs: restyle mkdocs to match Gateway API theme
- Add navigation tabs, light/dark toggle, rounded search box - Use custom primary color (#0A65C0) matching Frame brand - Add SVG logo (color and white variants) for header and favicon - Hide header title in favor of logo, enlarge logo display - Remove missing nav entries (ai-assistant-mode.md, blueprints.md) - Exclude docs/venv/ and site/ from git
1 parent 72ce533 commit 5f98927

File tree

5 files changed

+136
-18
lines changed

5 files changed

+136
-18
lines changed

.gitignore

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,7 @@ coverage.out
1919
.idea/
2020
vendor/
2121
tests_runner/*.pem
22-
tests_runner/*.srl
22+
tests_runner/*.srl
23+
bin/
24+
docs/venv/
25+
site/

docs/assets/logo-white.svg

Lines changed: 29 additions & 0 deletions
Loading

docs/assets/logo.svg

Lines changed: 29 additions & 0 deletions
Loading

docs/assets/styles.css

Lines changed: 44 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,46 @@
1+
/* Frame primary color */
12
:root {
3+
--md-primary-fg-color: #0A65C0;
24
--md-text-font: "IBM Plex Sans", system-ui, -apple-system, Segoe UI, Roboto, sans-serif;
35
--md-code-font: "IBM Plex Mono", ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
46
}
57

8+
/* Hide title in favor of logo */
9+
.md-header__topic {
10+
display: none;
11+
}
12+
13+
/* Increase size of logo */
14+
.md-header__button.md-logo img,
15+
.md-header__button.md-logo svg {
16+
height: 1.8rem;
17+
}
18+
19+
/* Always show tabs, even on smaller screens */
20+
@media screen and (max-width: 76.234375em) {
21+
.md-header__button.md-logo {
22+
display: block;
23+
}
24+
25+
.md-tabs {
26+
display: block;
27+
}
28+
}
29+
30+
/* Rounded search box + results */
31+
.md-search__form {
32+
border-radius: .5rem;
33+
}
34+
35+
[data-md-toggle=search]:checked~.md-header .md-search__form {
36+
border-radius: .5rem .5rem 0 0;
37+
}
38+
39+
[dir=ltr] .md-search__output {
40+
border-radius: 0 0 .5rem .5rem;
41+
}
42+
43+
/* Typography */
644
.md-typeset h1 {
745
letter-spacing: -0.02em;
846
}
@@ -15,14 +53,12 @@
1553
font-size: 0.9em;
1654
}
1755

18-
.md-typeset table {
19-
font-size: 0.95em;
20-
}
21-
22-
.md-header {
23-
box-shadow: none;
56+
/* Make tables use the maximum available size */
57+
.md-typeset__table {
58+
min-width: 100%;
59+
width: 100%;
2460
}
2561

26-
.md-footer {
27-
display: none;
62+
.md-typeset table {
63+
font-size: 0.95em;
2864
}

mkdocs.yml

Lines changed: 30 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,54 @@ site_url: "https://pitabwire.github.io/frame/"
44
repo_name: pitabwire/frame
55
repo_url: "https://github.com/pitabwire/frame"
66
edit_uri: "edit/main/docs/"
7+
exclude_docs: |
8+
venv/
79
810
theme:
911
name: material
10-
language: en
12+
logo: assets/logo-white.svg
13+
favicon: assets/logo.svg
14+
icon:
15+
repo: fontawesome/brands/git-alt
1116
features:
12-
- navigation.instant
13-
- navigation.tracking
14-
- navigation.sections
15-
- navigation.expand
17+
- search.highlight
18+
- navigation.tabs
1619
- navigation.top
17-
- content.code.copy
20+
- navigation.expand
1821
- content.tabs.link
22+
- content.code.copy
1923
palette:
2024
- scheme: default
21-
primary: deep orange
22-
accent: teal
25+
primary: custom
26+
toggle:
27+
icon: material/brightness-7
28+
name: Switch to dark mode
29+
- scheme: slate
30+
primary: custom
31+
toggle:
32+
icon: material/brightness-4
33+
name: Switch to light mode
2334
font:
2435
text: "IBM Plex Sans"
2536
code: "IBM Plex Mono"
2637

2738
markdown_extensions:
2839
- admonition
29-
- codehilite
40+
- pymdownx.emoji:
41+
emoji_index: !!python/name:material.extensions.emoji.twemoji
42+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
43+
- pymdownx.details
44+
- pymdownx.highlight
45+
- pymdownx.inlinehilite
46+
- pymdownx.superfences
47+
- pymdownx.snippets
48+
- pymdownx.tabbed:
49+
alternate_style: true
3050
- toc:
3151
permalink: true
3252
- attr_list
3353
- md_in_html
54+
- tables
3455

3556
plugins:
3657
- search

0 commit comments

Comments
 (0)