Add note about palette to toc.follow documentation (#411)

Closes #380 Co-authored-by: Brendan <[email protected]>
jbms · Feb 25, 2025 · 8def179 · 8def179
1 parent 255f634
commit 8def179
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/customization.rst b/docs/customization.rst
@@ -298,6 +298,11 @@ Configuration Options
             Note that if the ``toc.integrate`` feature is enabled, the left
             sidebar is instead scrolled for the local table-of-contents as
             described above.
+
+          .. warning::
+             When enabling the ``toc.follow`` feature,
+             a `palette` must be set to avoid some known undesirable behavior.
+             See `issue 380 <https://github.com/jbms/sphinx-immaterial/issues/380>`_.
         - ``toc.sticky``
 
           Makes headings in the left and right sidebars "sticky", such that the