How to enable announcements when using GitHub pages

[jicowan]

Hello, I am trying to add a header to my mkdocs site using the announcements bar feature. I created an overrides directory in the root of the project. I also created a base.html file with the following code:

{% extends "base.html" %}

{% block announce %}
  *My announcement*
{% endblock %}

I updated my mkdocs.yml file with custom_dir: overrides too. When I try building and deploying my site I get the following error:

Traceback (most recent call last):
  File "/opt/hostedtoolcache/Python/3.11.2/x64/bin/mkdocs", line 8, in <module>
    sys.exit(cli())
             ^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/click/core.py", line 1130, in __call__
    return self.main(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/click/core.py", line 1055, in main
    rv = self.invoke(ctx)
         ^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/click/core.py", line 1657, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
                           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/click/core.py", line 1404, in invoke
    return ctx.invoke(self.callback, **ctx.params)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/click/core.py", line 760, in invoke
    return __callback(*args, **kwargs)
           ^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/mkdocs/__main__.py", line 277, in gh_deploy_command
    build.build(cfg, dirty=not clean)
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/mkdocs/commands/build.py", line 320, in build
    _build_theme_template(template, env, files, config, nav)
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/mkdocs/commands/build.py", line 1[18](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:19), in _build_theme_template
    output = _build_template(template_name, template, files, config, nav)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/mkdocs/commands/build.py", line 97, in _build_template
    output = template.render(context)
             ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/jinja2/environment.py", line 1[30](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:31)1, in render
    self.environment.handle_exception()
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/jinja2/environment.py", line 9[36](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:37), in handle_exception
    raise rewrite_traceback_stack(source=source)
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/material/[40](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:41)4.html", line 4, in top-level template code
    {% extends "main.html" %}
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/material/main.html", line 4, in top-level template code
    {% extends "base.html" %}
  File "/home/runner/work/aws-eks-best-practices/aws-eks-best-practices/overrides/base.html", line 1, in top-level template code
    {% extends "base.html" %}
  File "/home/runner/work/aws-eks-best-practices/aws-eks-best-practices/overrides/base.html", line 1, in top-level template code
    {% extends "base.html" %}
  File "/home/runner/work/aws-eks-best-practices/aws-eks-best-practices/overrides/base.html", line 1, in top-level template code
    {% extends "base.html" %}
  [Previous line repeated 977 more times]
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/jinja2/utils.py", line [46](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:47)6, in get
    return self[key]
           ~~~~^^^^^
  File "/opt/hostedtoolcache/Python/3.11.2/x64/lib/python3.11/site-packages/jinja2/utils.py", line [50](https://github.com/aws/aws-eks-best-practices/actions/runs/4367740944/jobs/7639432896#step:5:51)4, in __getitem__
    rv = self._mapping[key]
         ~~~~~~~~~~~~~^^^^^
RecursionError: maximum recursion depth exceeded in comparison
Error: Process completed with exit code 1.

Does anyone know what might be wrong? Does announcements work with GitHub pages?

[jicowan]

Had to use main.html rather than base.html.