Merge pull request plone#1511 from plone/add-myst-extensions

Add myst extensions and include omitted container example

Author: ericof

docs/conf.py

@@ -149,14 +149,14 @@
 # For more information see:
 # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
 myst_enable_extensions = [
-    "deflist",  # You will be able to utilise definition lists
+    "deflist",  # Support definition lists.
     # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
-    "linkify",  # Identify “bare” web URLs and add hyperlinks.
+    "linkify",  # Identify "bare" web URLs and add hyperlinks.
     "colon_fence",  # You can also use ::: delimiters to denote code fences,\
     #  instead of ```.
     "substitution",  # plone.restapi \
     # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
-    "html_image",  # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
+    "html_image",  # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images
 ]
 
 myst_substitutions = {

docs/contributing/documentation/index.md

@@ -315,6 +315,6 @@ hidden: true
 setup-build
 authors
 myst-reference
-sphinx-extensions
+themes-and-extensions
 admins
 ```

…uting/documentation/sphinx-extensions.md …g/documentation/themes-and-extensions.mddocs/contributing/documentation/sphinx-extensions.md renamed to docs/contributing/documentation/themes-and-extensions.md docs/contributing/documentation/sphinx-extensions.md renamed to docs/contributing/documentation/themes-and-extensions.md

@@ -1,19 +1,20 @@
 ---
 myst:
   html_meta:
-    "description": "Sphinx themes and extensions"
-    "property=og:description": "Sphinx themes and extensions"
-    "property=og:title": "Sphinx themes and extensions"
+    "description": "Themes and extensions"
+    "property=og:description": "Themes and extensions"
+    "property=og:title": "Themes and extensions"
     "keywords": "Documentation, Plone, Sphinx, reStructuredText, MyST, Markdown, themes, sphinx-book-theme, pydata_sphinx_theme, extensions"
 ---
 
-(contributing-sphinx-themes-and-extensions)=
+(contributing-themes-and-extensions)=
 
-# Sphinx themes and extensions
+# Themes and extensions
 
 We learned the hard way that maintaining the design and features of documentation is a lot of work.
 To make all documentation maintainable, we use actively developed themes and extensions to build the documentation.
 
+
 ## Themes
 
 When customizing the theme, we use [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/), which in turn depends on [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html).
@@ -25,7 +26,19 @@ The one large customization is the search filter by part of the documentation, i
 
 ## Extensions
 
-We use several Sphinx extensions to enhance the presentation of Plone documentation.
+We use several MyST and Sphinx extensions to enhance the presentation of Plone documentation.
+
+
+### MyST
+
+-   [`deflist`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) supports definition lists.
+-   [`linkify`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#linkify) identifies "bare" web URLs and adds hyperlinks.
+-   [`colon_fence`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#code-fences-using-colons) supports the use of three colons `:::` as delimiters to denote code fences, instead of three backticks `` ``` ``.
+-   [`substitution`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2) supports the use of substitutions with Jinja2.
+-   [`html_image`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images) supports the use of HTML `<img>` tags.
+
+
+### Sphinx
 
 -   [`sphinx.ext.graphviz`](https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html) allows you to embed [Graphviz](https://graphviz.org/download/) graphs in your documents.
 -   [`sphinx.ext.intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) provides linking between separate projects that use Sphinx for documentation.

docs/install/containers/examples/index.md

@@ -18,6 +18,7 @@ nginx-volto-plone-zeo
 nginx-volto-plone-postgresql
 nginx-plone
 haproxy-plone-zeo
+traefik-volto-plone-varnish
 ```
 
 Examples of projects running Plone using `docker compose`.
@@ -29,3 +30,4 @@ Examples of projects running Plone using `docker compose`.
 | [nginx-volto-plone-postgresql](nginx-volto-plone-postgresql) | Stack with nginx, Frontend, Backend, and PostgreSQL DB |
 | [nginx-plone](nginx-plone) | Stack with nginx and Backend (Plone Classic) |
 | [haproxy-plone-zeo](haproxy-plone-zeo) | Stack with HAProxy, Backend, and ZEO server |
+| [traefik-volto-plone-varnish](traefik-volto-plone-varnish) | Stack with traefik, Frontend, Backend, Varnish |