Better comments in master template

usebedrock · Jun 22, 2021 · 5e7e2e5 · 5e7e2e5
1 parent f121e2a
commit 5e7e2e5
Showing 1 changed file with 13 additions and 5 deletions.
diff --git a/content/templates/_layouts/master.pug b/content/templates/_layouts/master.pug
@@ -1,16 +1,20 @@
-//- Globally expose mixins without output, needed for prototypes
+//- Globally expose mixins without output, needed for Bedrock to work
 include ../../../core/templates/mixins/icon
 include ../../../core/templates/mixins/render-page-tree
 include ../../../core/templates/mixins/sample
 include ../../../core/templates/mixins/styleguide-settings
+//- Use this include to add your own mixins
 include ../_mixins/all
 
 block pageVariables
     //- Use this block to append page variables in templates
+    //- @see https://bedrockapp.org/2021/06/22/setting-a-class-to-the-html-or-body-element/
     - var projectTitle = "Bedrock"
     - var htmlClass = ""
     - var bodyClass = ""
 
+//- Use this block to customize the styleguide
+//- @see https://bedrockapp.org/documentation/styling-the-style-guide/
 block append styleguideSettings
     - var styleguideLogoAsImage = true
     - var styleguideLogoAsImagePath = "/images/bedrock-logo-black.svg"
@@ -30,10 +34,14 @@ html(dir="ltr" lang="en" class=htmlClass ? htmlClass : '')
 
         link(rel="stylesheet" href="/css/main.css")
         link(rel="stylesheet" href="/css/prototype.css")
-        link(rel="stylesheet" href="/css/styleguide.css")
+
+        //- Remove this in production
+        if config.styleguide
+            link(rel="stylesheet" href="/css/styleguide.css")
 
         block headerStyles
-            // Nothing yet
+            //- Use this block to add scripts to the footer
+            //- @see https://bedrockapp.org/2021/06/22/how-to-add-scripts-to-header-and-footer/
 
     body(class=bodyClass ? bodyClass : '')
 
@@ -42,10 +50,10 @@ html(dir="ltr" lang="en" class=htmlClass ? htmlClass : '')
             .br-prototype-content
                 block body
 
-
         = "\n"
         script(src='/js/bundle-prototype.js')
         script(src='/js/bundle-client.js')
 
         block footerScripts
-            // Nothing yet
+            //- Use this block to add scripts to the footer
+            //- @see https://bedrockapp.org/2021/06/22/how-to-add-scripts-to-header-and-footer/