Skip to content

docs(theme): upgrade mkdocs material to 8.x #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,4 @@ venv
site

# Generated API documentation (from TypeDoc)
/api
/api
Binary file not shown.
8 changes: 8 additions & 0 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{% extends "base.html" %}

{% block outdated %}
You're not viewing the latest version.
<a href="{{ '../' ~ base_url }}">
<strong>Click here to go to latest.</strong>
</a>
{% endblock %}
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
mike==1.1.2
mkdocs-material==8.0.5
mkdocs-material==8.1.9
mkdocs-git-revision-date-plugin==0.3.1
9 changes: 7 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,10 @@ theme:
- navigation.sections
- navigation.expand
- navigation.top
- navigation.instant
- navigation.indexes
- navigation.tracking
- content.code.annotate
icon:
repo: fontawesome/brands/github
logo: media/aws-logo-light.svg
Expand All @@ -58,9 +62,9 @@ markdown_extensions:
- attr_list
- pymdownx.emoji
- pymdownx.inlinehilite
- attr_list
- pymdownx.superfences

copyright: Copyright &copy; 2021 Amazon Web Services
copyright: Copyright &copy; 2022 Amazon Web Services

plugins:
- git-revision-date
Expand All @@ -75,3 +79,4 @@ extra_javascript:
extra:
version:
provider: mike
default: latest