Skip to content

Commit 18228d5

Browse files
authored
docs(theme): upgrade mkdocs material to 8.x (#534)
* chore: bump mkdocs + add annotation plugins * docs: updated year in copyright notice * chore: remove redundant ignore
1 parent e736b65 commit 18228d5

File tree

5 files changed

+17
-4
lines changed

5 files changed

+17
-4
lines changed

Diff for: .gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,4 +38,4 @@ venv
3838
site
3939

4040
# Generated API documentation (from TypeDoc)
41-
/api
41+
/api
-70.8 KB
Binary file not shown.

Diff for: docs/overrides/main.html

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{% extends "base.html" %}
2+
3+
{% block outdated %}
4+
You're not viewing the latest version.
5+
<a href="{{ '../' ~ base_url }}">
6+
<strong>Click here to go to latest.</strong>
7+
</a>
8+
{% endblock %}

Diff for: docs/requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
mike==1.1.2
2-
mkdocs-material==8.0.5
2+
mkdocs-material==8.1.9
33
mkdocs-git-revision-date-plugin==0.3.1

Diff for: mkdocs.yml

+7-2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ theme:
3434
- navigation.sections
3535
- navigation.expand
3636
- navigation.top
37+
- navigation.instant
38+
- navigation.indexes
39+
- navigation.tracking
40+
- content.code.annotate
3741
icon:
3842
repo: fontawesome/brands/github
3943
logo: media/aws-logo-light.svg
@@ -58,9 +62,9 @@ markdown_extensions:
5862
- attr_list
5963
- pymdownx.emoji
6064
- pymdownx.inlinehilite
61-
- attr_list
65+
- pymdownx.superfences
6266

63-
copyright: Copyright &copy; 2021 Amazon Web Services
67+
copyright: Copyright &copy; 2022 Amazon Web Services
6468

6569
plugins:
6670
- git-revision-date
@@ -75,3 +79,4 @@ extra_javascript:
7579
extra:
7680
version:
7781
provider: mike
82+
default: latest

0 commit comments

Comments
 (0)