Skip to content

Commit 0cea555

Browse files
deeenesclaude
andcommitted
Apply OmniPath brand theme to mkdocs
- Custom CSS with OmniPath colors: teal (#007B7F), green (#6EA945) - Favicon from omnipathdb.org - Material theme with light/dark toggle Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 778687e commit 0cea555

5 files changed

Lines changed: 56 additions & 114 deletions

File tree

docs/assets/favicon-32x32.png

1.85 KB
Loading

docs/assets/favicon.ico

14.7 KB
Binary file not shown.

docs/assets/omnipath-theme.css

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:root {
2+
--md-primary-fg-color: #007B7F;
3+
--md-accent-fg-color: #6EA945;
4+
}
5+
[data-md-color-scheme="slate"] {
6+
--md-primary-fg-color: #007B7F;
7+
--md-accent-fg-color: #6EA945;
8+
}
9+
.md-header {
10+
background-color: #007B7F;
11+
}

mkdocs.yml

Lines changed: 44 additions & 113 deletions
Original file line numberDiff line numberDiff line change
@@ -1,119 +1,50 @@
1-
site_name: pkg_infra
2-
site_url: https://saezlab.github.io/pkg_infra
3-
hooks:
4-
- docs/hooks.py
5-
theme:
6-
name: material
7-
logo: assets/logo-pkg-infra.png
8-
favicon: assets/logo-pkg-infra.png
9-
font:
10-
text: Lato
11-
code: Roboto Mono
12-
features:
13-
- content.code.copy
14-
- content.action.edit
15-
- navigation.tabs
16-
- navigation.instant
17-
- navigation.footer
18-
palette:
19-
- scheme: default
20-
primary: custom
21-
accent: custom
22-
toggle:
23-
icon: material/toggle-switch
24-
name: Switch to dark mode
25-
- scheme: slate
26-
primary: custom
27-
accent: custom
28-
toggle:
29-
icon: material/toggle-switch-off
30-
name: Switch to light mode
31-
32-
#======= Website Navigation settings =====
33-
nav:
34-
- Home: index.md
35-
36-
- About:
37-
- Project: pkg_infra-project/project.md
38-
- Design philosophy: pkg_infra-project/design-philosophy.md
39-
- Use Cases: pkg_infra-project/use-cases.md
40-
- About: about.md
1+
site_name: pkg-infra
2+
site_url: https://saezlab.github.io/pkg-infra
3+
repo_url: https://github.com/saezlab/pkg-infra
4+
repo_name: saezlab/pkg-infra
415

42-
- Get Started:
43-
- Installation: installation.md
44-
45-
- Learn:
46-
- Tutorials:
47-
- Quickstart: learn/tutorials/quickstart.md
48-
- How-To Guides:
49-
- Overview: learn/guides/index.md
50-
- Writing and overriding configuration: learn/guides/config-overrides.md
51-
52-
- Explanations:
53-
- Core concepts: learn/tutorials/tutorial0001_basics.md
54-
- Overview: learn/explanation/index.md
55-
- Default schema and baseline configuration: learn/explanation/default-schema.md
6+
theme:
7+
name: material
8+
favicon: assets/favicon.ico
9+
icon:
10+
logo: material/database
11+
palette:
12+
- media: "(prefers-color-scheme: light)"
13+
scheme: default
14+
primary: custom
15+
accent: custom
16+
toggle:
17+
icon: material/brightness-7
18+
name: Switch to dark mode
19+
- media: "(prefers-color-scheme: dark)"
20+
scheme: slate
21+
primary: custom
22+
accent: custom
23+
toggle:
24+
icon: material/brightness-4
25+
name: Switch to light mode
5626

57-
- Reference:
58-
- API Documentation:
59-
- pkg_infra: reference/source/pkg_infra/pkg_infra-docs.md
60-
- config: reference/source/pkg_infra/config-docs.md
61-
- session: reference/source/pkg_infra/session-docs.md
62-
- logger: reference/source/pkg_infra/logger-docs.md
63-
- schema: reference/source/pkg_infra/schema-docs.md
64-
- metadata: reference/source/pkg_infra/_metadata-docs.md
65-
- Community:
66-
- Join Us: community/index.md
67-
- Where to Start: community/contribute.md
68-
- Contribute to the Documentation: community/contribute-docs.md
69-
- Contribute to the Code Base: community/contribute-codebase.md
27+
extra_css:
28+
- assets/omnipath-theme.css
7029

30+
plugins:
31+
- search
32+
- mkdocstrings:
33+
handlers:
34+
python:
35+
paths: ["."]
36+
options:
37+
show_source: false
38+
show_root_heading: true
7139

40+
nav:
41+
- Home: index.md
7242

73-
#======= Extension settings (sorted alphabetically) =====
7443
markdown_extensions:
75-
- admonition
76-
- attr_list
77-
- md_in_html
78-
#----- Python Markdown Extensions
79-
- pymdownx.details
80-
- pymdownx.emoji:
81-
emoji_index: !!python/name:material.extensions.emoji.twemoji
82-
emoji_generator: !!python/name:material.extensions.emoji.to_svg
83-
- pymdownx.highlight: # Note: list of Pygments: https://pygments.org/docs/lexers/
84-
anchor_linenums: true
85-
line_spans: __span
86-
pygments_lang_class: true
87-
- pymdownx.inlinehilite
88-
- pymdownx.snippets
89-
- pymdownx.superfences:
90-
custom_fences:
91-
- name: mermaid
92-
class: mermaid
93-
format: !!python/name:pymdownx.superfences.fence_code_format
94-
- pymdownx.tabbed:
95-
alternate_style: true
96-
97-
#======= Plugins =====
98-
plugins:
99-
- search
100-
- mkdocstrings:
101-
default_handler: python
102-
handlers:
103-
python:
104-
paths:
105-
- .
106-
options:
107-
annotations_path: brief
108-
docstring_style: google
109-
heading_level: 3
110-
modernize_annotations: true
111-
show_category_heading: true
112-
show_object_full_path: false
113-
show_root_toc_entry: true
114-
show_signature: true
115-
show_signature_annotations: false
116-
signature_crossrefs: true
117-
118-
extra_css:
119-
- stylesheets/extra.css
44+
- pymdownx.highlight
45+
- pymdownx.superfences
46+
- pymdownx.tabbed:
47+
alternate_style: true
48+
- admonition
49+
- toc:
50+
permalink: true

uv.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)