✨ Add newsletter: FastAPI and friends (#2509)

* ✨ Add newsletter: FastAPI and friends

* 🔧 Update MkDocs config for announcement

* 🔧 Update generation script to include overrides for announcements

docs/en/docs/css/custom.css

@@ -55,3 +55,11 @@ a.internal-link::after {
   font-size: 80%;
   text-align: center;
 }
+
+a.announce:link, a.announce:visited {
+  color: #fff;
+}
+
+a.announce:hover {
+  color: var(--md-accent-fg-color);
+}

docs/en/docs/help-fastapi.md

@@ -10,6 +10,16 @@ There are very simple ways to help (several involve just one or two clicks).
 
 And there are several ways to get help too.
 
+## Subscribe to the newsletter
+
+You can subscribe to the (infrequent) [**FastAPI and friends** newsletter](/newsletter/){.internal-link target=_blank} to stay updated about:
+
+* News about FastAPI and friends 🚀
+* Guides 📝
+* Features ✨
+* Breaking changes 🚨
+* Tips and tricks ✅
+
 ## Star **FastAPI** in GitHub
 
 You can "star" FastAPI in GitHub (clicking the star button at the top right): <a href="https://github.com/tiangolo/fastapi" class="external-link" target="_blank">https://github.com/tiangolo/fastapi</a>. ⭐️

docs/en/docs/newsletter.md

@@ -0,0 +1,5 @@
+# FastAPI and friends newsletter
+
+<iframe class="mj-w-res-iframe" frameborder="0" scrolling="no" marginheight="0" marginwidth="0" src="https://app.mailjet.com/widget/iframe/6gQ4/GDo" width="100%"></iframe>
+
+<script type="text/javascript" src="https://app.mailjet.com/statics/js/iframeResizer.min.js"></script>

docs/en/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/en/overrides/main.html

@@ -0,0 +1,9 @@
+{% extends "base.html" %}
+
+{% block announce %}
+<a class="announce" href="https://fastapi.tiangolo.com/newsletter/">
+    <span class="twemoji">
+        {% include ".icons/material/email.svg" %}
+      </span> Subscribe to the <strong>FastAPI and friends</strong> newsletter 🎉
+  </a>
+{% endblock %}

docs/es/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/es/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/fr/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/fr/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/it/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/it/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/ja/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/ja/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/ko/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/ko/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/pt/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/pt/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/ru/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/ru/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/tr/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/tr/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/uk/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/uk/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

docs/zh/mkdocs.yml

@@ -3,6 +3,7 @@ site_description: FastAPI framework, high performance, easy to learn, fast to co
 site_url: https://fastapi.tiangolo.com/zh/
 theme:
   name: material
+  custom_dir: overrides
   palette:
   - scheme: default
     primary: teal

scripts/docs.py

@@ -136,6 +136,7 @@ def build_lang(
     shutil.rmtree(build_lang_path, ignore_errors=True)
     shutil.copytree(lang_path, build_lang_path)
     shutil.copytree(en_docs_path / "data", build_lang_path / "data")
+    shutil.copytree(en_docs_path / "overrides", build_lang_path / "overrides")
     en_config_path: Path = en_lang_path / mkdocs_name
     en_config: dict = mkdocs.utils.yaml_load(en_config_path.read_text(encoding="utf-8"))
     nav = en_config["nav"]