Post: MkDocs YAML manipulation (#277)

* Post: MkDocs YAML manipulation Blog post announcing the depreaction of the `mkdocs.yml` manipulation done by Read the Docs at build time, following the plan described. Related: * readthedocs/addons#72 (comment) * readthedocs/readthedocs.org#11206 * readthedocs/readthedocs.org#8529 * Use double quotes The other ones don't render properly. * Apply suggestions from code review Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com> --------- Co-authored-by: Eric Holscher <25510+ericholscher@users.noreply.github.com>
readthedocs · Mar 25, 2024 · c9360b6 · c9360b6
1 parent a776aad
commit c9360b6
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/content/images/mkdocs-yaml-manipulation.jpg b/content/images/mkdocs-yaml-manipulation.jpg
diff --git a/content/posts/mkdocs-yaml-manipulation.md b/content/posts/mkdocs-yaml-manipulation.md
@@ -0,0 +1,27 @@
+title: Build process change: removing changes to mkdocs.yml
+date: 2024-03-25
+category: Changelog
+tags: builders, deprecation, mkdocs, addons
+authors: Manuel Kaufmann
+status: published
+image: /images/mkdocs-yaml-manipulation.jpg
+image_credit: Photo by <a href="https://unsplash.com/@flowforfrank?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Ferenc Almasi</a> on <a href="https://unsplash.com/photos/text-yXrl2lkGJ-k?utm_content=creditCopyText&utm_medium=referral&utm_source=unsplash">Unsplash</a>
+
+
+We are announcing the deprecation of the `mkdocs.yml` manipulation done by Read the Docs at build time on **Monday, April 15th, 2024**.
+After this date, there will be some changes in build process behavior:
+
+* MkDocs default theme will be used if your documentation is not defining one on its `mkdocs.yml` file.
+  If you want to continue using the `readthedocs` theme, read [Choosing your Theme](https://www.mkdocs.org/user-guide/choosing-your-theme/) MkDocs' documentation
+  to learn how to explicity define it in the configuration file.
+* [The new beta Read the Docs Addons](https://blog.readthedocs.com/addons-flyout-menu-beta/) will be enabled by default.
+
+
+We've made this decision to simplify the build process executed on Read the Docs,
+allowing our users to get the same results when building their documentation locally and on our platform.
+This simplification allows more complex configuration in the YAML by using the special `!!` syntax
+[that wasn't previously supported due to security reasons](https://github.com/readthedocs/readthedocs.org/issues/8529).
+
+
+[Contact us](https://readthedocs.org/support/) if you have any questions,
+and let us know any inconvenient you may have with this change.