Skip to content

Commit 4684d98

Browse files
steven-vargasteven-varga
committed
[#2]:svarga:mkdocs, initial setup following common site patterns
1 parent eb2906b commit 4684d98

14 files changed

Lines changed: 782 additions & 0 deletions

‎docs/assets/elliptic-curve-dark.svg‎

Lines changed: 58 additions & 0 deletions
Loading

‎docs/assets/elliptic-curve-light.svg‎

Lines changed: 58 additions & 0 deletions
Loading

‎docs/assets/hex-dark.svg‎

Lines changed: 12 additions & 0 deletions
Loading

‎docs/assets/hex-light.svg‎

Lines changed: 12 additions & 0 deletions
Loading

‎docs/assets/logo.svg‎

Lines changed: 26 additions & 0 deletions
Loading

‎docs/assets/scribble-dark.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/assets/scribble-light.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/javascripts/tw-config.js‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
// Keep Material’s base styles intact
2+
tailwind.config = {
3+
corePlugins: { preflight: false },
4+
};

‎docs/overrides/partials/footer.html‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
<footer class="md-footer">
2+
{% if "navigation.footer" in features %}
3+
{% if page.previous_page or page.next_page %}
4+
{% if page.meta and page.meta.hide %}
5+
{% set hidden = "hidden" if "footer" in page.meta.hide %}
6+
{% endif %}
7+
<nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer') }}" {{ hidden }}>
8+
{% if page.previous_page %}
9+
{% set direction = lang.t("footer.previous") %}
10+
<a href="{{ page.previous_page.url | url }}" class="md-footer__link md-footer__link--prev" aria-label="{{ direction }}: {{ page.previous_page.title | e }}">
11+
<div class="md-footer__button md-icon">
12+
{% set icon = config.theme.icon.previous or "material/arrow-left" %}
13+
{% include ".icons/" ~ icon ~ ".svg" %}
14+
</div>
15+
<div class="md-footer__title">
16+
<span class="md-footer__direction">
17+
{{ direction }}
18+
</span>
19+
<div class="md-ellipsis">
20+
{{ page.previous_page.title }}
21+
</div>
22+
</div>
23+
</a>
24+
{% endif %}
25+
{% if page.next_page %}
26+
{% set direction = lang.t("footer.next") %}
27+
<a href="{{ page.next_page.url | url }}" class="md-footer__link md-footer__link--next" aria-label="{{ direction }}: {{ page.next_page.title | e }}">
28+
<div class="md-footer__title">
29+
<span class="md-footer__direction">
30+
{{ direction }}
31+
</span>
32+
<div class="md-ellipsis">
33+
{{ page.next_page.title }}
34+
</div>
35+
</div>
36+
<div class="md-footer__button md-icon">
37+
{% set icon = config.theme.icon.next or "material/arrow-right" %}
38+
{% include ".icons/" ~ icon ~ ".svg" %}
39+
</div>
40+
</a>
41+
{% endif %}
42+
</nav>
43+
{% endif %}
44+
{% endif %}
45+
<div class="md-footer-meta md-typeset">
46+
<div class="md-footer-meta__inner md-grid">
47+
<div class="md-copyright custom-footer">
48+
<div class="custom-footer-left">
49+
Blockchain, cryptographic protocols, HPC, or trading systems in C++, Rust, Julia, Python, R and CUDA
50+
</div>
51+
<div class="custom-footer-right">
52+
© 2017–2025 Varga Consulting, Toronto, ON, Canada 🇨🇦
53+
</div>
54+
</div>
55+
</div>
56+
</div>
57+
</footer>

‎docs/overrides/partials/header.html‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{% set class = "md-header" %}
2+
{% if "navigation.tabs.sticky" in features %}
3+
{% set class = class ~ " md-header--shadow md-header--lifted" %}
4+
{% elif "navigation.tabs" not in features %}
5+
{% set class = class ~ " md-header--shadow" %}
6+
{% endif %}
7+
<header class="{{ class }}" data-md-component="header">
8+
<nav class="md-header__inner md-grid" aria-label="{{ lang.t('header') }}">
9+
<a href="{{ config.extra.homepage | d(nav.homepage.url, true) | url }}" title="{{ config.site_name | e }}" class="md-header__button md-logo" aria-label="{{ config.site_name }}" data-md-component="logo">
10+
{% include "partials/logo.html" %}
11+
</a>
12+
<label class="md-header__button md-icon" for="__drawer">
13+
{% set icon = config.theme.icon.menu or "material/menu" %}
14+
{% include ".icons/" ~ icon ~ ".svg" %}
15+
</label>
16+
<div class="md-header__title" data-md-component="header-title">
17+
<div class="md-header__ellipsis">
18+
<div class="md-header__topic">
19+
<span class="md-ellipsis">{{ config.site_description | e }} </span>
20+
</div>
21+
<div class="md-header__topic" data-md-component="header-topic">
22+
<span class="md-ellipsis">
23+
{% if page.meta and page.meta.title %}
24+
{{ page.meta.title }}
25+
{% else %}
26+
{{ page.title }}
27+
{% endif %}
28+
</span>
29+
</div>
30+
</div>
31+
</div>
32+
{% if config.theme.palette %}
33+
{% if not config.theme.palette is mapping %}
34+
{% include "partials/palette.html" %}
35+
{% endif %}
36+
{% endif %}
37+
{% if not config.theme.palette is mapping %}
38+
{% include "partials/javascripts/palette.html" %}
39+
{% endif %}
40+
{% if config.extra.alternate %}
41+
{% include "partials/alternate.html" %}
42+
{% endif %}
43+
{% if config.repo_url %}
44+
<div class="md-header__source">
45+
{% include "partials/source.html" %}
46+
</div>
47+
{% endif %}
48+
</nav>
49+
{% if "navigation.tabs.sticky" in features %}
50+
{% if "navigation.tabs" in features %}
51+
{% include "partials/tabs.html" %}
52+
{% endif %}
53+
{% endif %}
54+
</header>

0 commit comments

Comments
 (0)