Comments for all the layout templates

3 years ago · 0abbb1857f
parent 55eae7b70b
commit 0abbb1857f
6 changed files with 23 additions and 3 deletions
--- a/layouts/docs/baseof.html
+++ b/layouts/docs/baseof.html
@ -1,3 +1,10 @@
+{{/*
+
+  A copy of the baseof.html partial in Docsy, modified
+	to remove the right-hand column from the layout.
+
+*/}}
+
 <!doctype html>
 <html lang="{{ .Site.Language.Lang }}" class="no-js">
  <head>
--- a/layouts/docs/list.html
+++ b/layouts/docs/list.html
@ -1,3 +1,9 @@
+{{/*
+
+  A simplified version of the list.html partial in Docsy.
+
+*/}}
+
 {{ define "main" }}
 <div class="td-content">
 	<h1>{{ .Title }}</h1>
--- a/layouts/partials/footer.html
+++ b/layouts/partials/footer.html
@ -1,3 +1,9 @@
+{{/*
+
+  A modified version of the footer.html partial in Docsy.
+
+*/}}
+
 {{ $links := .Site.Params.links }}
 <footer class="py-5 row d-print-none">
  <div class="container-fluid mx-sm-5">
--- a/layouts/partials/navbar.html
+++ b/layouts/partials/navbar.html
@ -1,6 +1,6 @@
 {{/*

-  A copy of the navbar.html partial in Docsy, only modified
+  A version of the navbar.html partial in Docsy, only modified
 	to include the spec version, which is calculated using an
  inline `version-string` partial.

--- a/layouts/partials/sidebar-tree.html
+++ b/layouts/partials/sidebar-tree.html
@ -1,6 +1,7 @@
 {{/*

-  A copy of the sidebar-tree.html partial in Docsy, with a few small modifications:
+  A version of the sidebar-tree.html partial in Docsy, with a few small
+  modifications:

  * include `div#toc` for the ToC
  * start the sidebar at the root (homepage) since for us that is the Matrix
--- a/layouts/partials/version-banner.html
+++ b/layouts/partials/version-banner.html
@ -1,6 +1,6 @@
 {{/*

-  A modified copy of the version-banner.html partial in Docsy.
+  A modified version of the version-banner.html partial in Docsy.

 */}}