Merge pull request #2036 from jvns/sidebar-toc

Display a table of contents in the sidebar of man pages

Author: dscho

assets/sass/dark-mode.css

@@ -22,6 +22,7 @@
     $main-border:             #e2e0d8;
     $bg-color:                #f0efe7 url($baseurl + "images/bg/body.jpg");
     $sidebar-bg-color:        #efefe7;
+    $sidebar-toc-bg-color:    lighten($sidebar-bg-color, 4%);
     $no-changes-bg-color:     #f5f5f3;
     $dropdown-active-bg-color: #fff;
     $versions-footer-bg-color: #eae9e0;
@@ -55,6 +56,7 @@
         $main-border:             #5e5e5a;
         $bg-color:                #2a2a2aff;
         $sidebar-bg-color:        #3d3d3a;
+        $sidebar-toc-bg-color:    #{$main-bg};
         $no-changes-bg-color:     #515150;
         $dropdown-active-bg-color: #515150;
         $versions-footer-bg-color: #1f1f1e;
@@ -185,6 +187,7 @@
         --main-bg:                      #{$main-bg};
         --main-border:                  #{$main-border};
         --sidebar-bg-color:             #{$sidebar-bg-color};
+        --sidebar-toc-bg-color:         #{$sidebar-toc-bg-color};
         --bg-color:                     #{$bg-color};
         --no-changes-bg-color:          #{$no-changes-bg-color};
         --dropdown-active-bg-color:     #{$dropdown-active-bg-color};

assets/sass/layout.scss

@@ -27,13 +27,37 @@ body {
 }
 
 aside {
-  float: left;
   width: 218px;
   margin-bottom: 35px;
+  position: sticky;
+  top: 0;
+  max-height: 100vh;
+  overflow-y: auto;
+  /* align with the top of the content */
+  padding-top: 46px;
+}
+
+#toc {
+  border: 1px solid var(--main-border);
+  padding: .5em;
+  margin-top: 1rem;
+  border-top: 1px solid var(--main-border);
+  background: var(--sidebar-toc-bg-color);
+  margin-right: 0.5rem;
+}
+
+#toc ul {
+  list-style-type: square;
+}
+
+#toc li {
+  /* use margin instead of line height for spacing because sometimes the
+     headings wrap onto multiple lines */
+  line-height: 1.2em;
+  margin: 6px 0;
 }
 
 #content {
-  float: right;
   width: 702px;
 }
 
@@ -437,6 +461,10 @@ table.benchmarks {
   }
 }
 
+#content-wrapper {
+  display: flex;
+}
+
 // Breakpoint ----------------
 @media (max-width: $default) {
   .responsive-table { overflow-x: auto; }

external/docs/content/docs/BreakingChanges.html

@@ -7,6 +7,13 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.50.0
+headings:
+- text: Procedure
+  id: _procedure
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 latest-changes: 2.50.0
 aliases:
 - "/docs/BreakingChanges/index.html"

external/docs/content/docs/BreakingChanges/2.46.0.html

@@ -7,6 +7,11 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.46.0
+headings:
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 aliases:
 - "/docs/BreakingChanges/2.46.0/index.html"
 - "/docs/BreakingChanges/2.46.1/index.html"

external/docs/content/docs/BreakingChanges/2.47.0.html

@@ -7,6 +7,11 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.47.0
+headings:
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 aliases:
 - "/docs/BreakingChanges/2.47.0/index.html"
 - "/docs/BreakingChanges/2.47.1/index.html"

external/docs/content/docs/BreakingChanges/2.48.0.html

@@ -7,6 +7,13 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.48.0
+headings:
+- text: Procedure
+  id: _procedure
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 aliases:
 - "/docs/BreakingChanges/2.48.0/index.html"
 - "/docs/BreakingChanges/2.48.1/index.html"

external/docs/content/docs/BreakingChanges/2.49.0.html

@@ -7,6 +7,13 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.49.0
+headings:
+- text: Procedure
+  id: _procedure
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 aliases:
 - "/docs/BreakingChanges/2.49.0/index.html"
 - "/docs/BreakingChanges/2.49.1/index.html"

external/docs/content/docs/BreakingChanges/2.50.0.html

@@ -7,6 +7,13 @@
 title: Git - BreakingChanges Documentation
 docname: BreakingChanges
 version: 2.50.0
+headings:
+- text: Procedure
+  id: _procedure
+- text: Git 3.0
+  id: _git_3_0
+- text: Superseded features that will not be deprecated
+  id: _superseded_features_that_will_not_be_deprecated
 aliases:
 - "/docs/BreakingChanges/2.50.0/index.html"
 - "/docs/BreakingChanges/2.50.1/index.html"

external/docs/content/docs/MyFirstContribution.html

@@ -7,6 +7,23 @@
 title: Git - MyFirstContribution Documentation
 docname: MyFirstContribution
 version: 2.50.0
+headings:
+- text: Summary
+  id: summary
+- text: Getting Started
+  id: getting-started
+- text: Code It Up!
+  id: code-it-up
+- text: Testing
+  id: testing
+- text: 'Getting Ready to Share: Anatomy of a Patch Series'
+  id: ready-to-share
+- text: Sending Patches via GitGitGadget
+  id: howto-ggg
+- text: Sending Patches with git send-email
+  id: howto-git-send-email
+- text: My Patch Got Emailed - Now What?
+  id: now-what
 latest-changes: 2.50.0
 aliases:
 - "/docs/MyFirstContribution/index.html"

external/docs/content/docs/MyFirstContribution/2.23.0.html

@@ -7,6 +7,23 @@
 title: Git - MyFirstContribution Documentation
 docname: MyFirstContribution
 version: 2.23.0
+headings:
+- text: Summary
+  id: summary
+- text: Getting Started
+  id: getting-started
+- text: Code It Up!
+  id: code-it-up
+- text: Testing
+  id: testing
+- text: Getting Ready to Share
+  id: ready-to-share
+- text: Sending Patches via GitGitGadget
+  id: howto-ggg
+- text: Sending Patches with git send-email
+  id: howto-git-send-email
+- text: My Patch Got Emailed - Now What?
+  id: now-what
 aliases:
 - "/docs/MyFirstContribution/2.23.0/index.html"
 - "/docs/MyFirstContribution/2.23.1/index.html"