Add readme info for the navigation marker pattern.

plone · Feb 5, 2019 · d8b6d11 · d8b6d11
1 parent 4d84788
commit d8b6d11
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/mockup/patterns/navigationmarker/pattern.js b/mockup/patterns/navigationmarker/pattern.js
@@ -1,3 +1,14 @@
+/* Navigation marker pattern.
+ *
+ * This pattern adds ``inPath`` and ``current`` classes to the navigation to
+ * allow a different style on selected navigation items or navigation items
+ * which are in the current path.
+ *
+ * This is done in JavaScript, so that the navigation pattern can be cached
+ * for the whole site.
+ *
+ */
+
 define([
     'jquery',
     'pat-base'