Merge pull request #5877 from chrisrueger/docs-additions

Structure side-bar into groups
bndtools · Nov 8, 2023 · 25789f4 · 25789f4
2 parents 884d8c3 + a4ec0f6
commit 25789f4
Show file tree

Hide file tree

Showing 7 changed files with 124 additions and 12 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,3 +6,17 @@ using [GitHub Pages](https://help.github.com/articles/what-are-github-pages/).
 
 [bndmanual]: https://bnd.bndtools.org
 [jekyll]: https://jekyllrb.com/
+
+## Local docs development
+
+```
+# Start the local Jekyll Dev-Server
+./run.sh
+```
+
+## Build docs
+
+```
+# Build it
+./build.sh
+```
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -43,6 +43,7 @@ exclude:
   - '.gitignore'
   - '.project'
   - 'build.sh'
+  - 'run.sh'
   - '/examples'
   - '/releases/*/CNAME'
   - '/releases/*/favicon.ico'

diff --git a/docs/_data/sidebar.yml b/docs/_data/sidebar.yml
@@ -0,0 +1,63 @@
+nav:
+  - title: Introduction
+    subfolderitems:
+      - url: /chapters/110-introduction.html
+  - title: Installation
+    subfolderitems:
+      - url: /chapters/120-install.html
+  - title: Getting Started
+    subfolderitems:
+      - url: /chapters/123-tour-workspace.html
+      - url: /chapters/125-tour-features.html
+  - title: Concepts and Practices
+    subfolderitems:
+      - url: /chapters/130-concepts.html
+      - url: /chapters/140-best-practices.html
+  - title: Build and Development
+    subfolderitems:
+      - url: /chapters/155-project-setup.html
+      - url: /chapters/160-jars.html
+      - url: /chapters/170-versioning.html
+      - url: /chapters/180-baselining.html
+      - url: /chapters/200-components.html
+      - url: /chapters/210-metatype.html
+      - url: /chapters/220-contracts.html
+      - url: /chapters/230-manifest-annotations.html
+      - url: /chapters/235-accessor-properties.html
+      - url: /chapters/240-spi-annotations.html
+  - title: Dependency and Launching
+    subfolderitems:
+      - url: /chapters/250-resolving.html
+      - url: /chapters/300-launching.html
+      - url: /chapters/305-startlevels.html
+  - title: Testing
+    subfolderitems:
+      - url: /chapters/310-testing.html
+      - url: /chapters/315-launchpad-testing.html
+  - title: Packaging and Distribution
+    subfolderitems:
+      - url: /chapters/320-packaging.html
+      - url: /chapters/330-jpms.html
+      - url: /chapters/390-wrapping.html
+  - title: Documentation and Tools
+    subfolderitems:
+      - url: /chapters/395-generating-documentation.html
+      - url: /chapters/400-commands.html
+      - url: /chapters/600-developer.html
+      - url: /chapters/650-windows.html
+      - url: /chapters/700-tools.html
+  - title: Reference Material
+    subfolderitems:
+      - url: /chapters/800-headers.html
+      - url: /chapters/820-instructions.html
+      - url: /chapters/825-instructions-ref.html
+      - url: /chapters/850-macros.html
+      - url: /chapters/855-macros-ref.html
+      - url: /chapters/870-plugins.html
+      - url: /chapters/875-external-plugins.html
+  - title: Configuration and Troubleshooting
+    subfolderitems:
+      - url: /chapters/880-settings.html
+      - url: /chapters/900-errors.html
+      - url: /chapters/910-warnings.html
+      - url: /chapters/920-faq.html
diff --git a/docs/_includes/sidebar.htm b/docs/_includes/sidebar.htm
@@ -1,9 +1,26 @@
-<ul class="side-nav">
-	{% for chapter in site.chapters %}
-		{% if chapter.title == page.title %}
-			<li class=selected>{{chapter.title}}
-	  	{% else %}
-			<li><a href="{{ chapter.url | prepend: site.baseurl }}">{{chapter.title}}</a>
-	  	{% endif %}
-  	{% endfor %}
-</ul>
+{% for item in site.data.sidebar.nav %}
+
+	<ul class="side-nav">
+	<li><span class="side-nav-section">{{ item.title }}</span>
+		<ul class="side-nav">
+		{% for entry in item.subfolderitems %}
+			{% for chapter in site.chapters %}
+				{% if entry.url == chapter.url %}
+
+					{% if entry.url == page.url %}
+					<li class=selected>{{chapter.title}}</li>
+					{% else %}
+					<li><a href="{{ entry.url | prepend: site.baseurl }}">{{chapter.title}}</a></li>
+					{% endif %}
+
+				{% endif %}
+
+			{% endfor %}
+
+		{% endfor %}
+		</ul>
+	</li>
+	</ul>
+{% endfor %}
+
+
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -11,7 +11,7 @@
 
 	<ul class=container12>
 		<li span=3>
-			<div>
+			<div class="side-nav">
 			{% include sidebar.htm %}
 			</div>
 

diff --git a/docs/css/style.scss b/docs/css/style.scss
@@ -1,7 +1,6 @@
 ---
 ---
 
-@import url("//fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,700italic,400,300,700");
 
 $font-family: 		Trebuchet MS, Verdana, sans;
 $font-size:			9pt;
@@ -125,6 +124,7 @@ $color-vignette:	#F0F0F0;
 	&:before { content: "\25B7\00A0"; }
 	font-weight: bolder;
 	color: $secondary-color;
+	font-size: 1.05em;
 }
 
 embed.illustration {
@@ -186,5 +186,15 @@ embed.illustration {
     font-weight: normal;
  }
 
+ul.side-nav{
+  list-style-type: none;
+}
+
+ul .side-nav-section{
+  color: #720F10;
+  font-weight: bold;
+}
 
-
+.side-nav{
+  padding-top: 1px !important;
+}
diff --git a/docs/run.sh b/docs/run.sh
@@ -0,0 +1,7 @@
+#!/bin/bash
+set -ev
+
+export BUNDLE_GEMFILE=$PWD/Gemfile
+bundle install --jobs=3 --retry=3
+bundle exec jekyll serve -w --incremental 
+