feat: enhance-github-pages (#23)

Introducing lib collection.

Author: mmichaelis

bin/docs.sh

@@ -23,7 +23,17 @@ readonly MY_PATH
 readonly SCRIPT_DIR
 readonly DOC_SINGLE="${SCRIPT_DIR}/doc-single.sh"
 readonly LIB_BASH_DIR="${SCRIPT_DIR}/.."
-readonly LIB_DOCS_DIR="${SCRIPT_DIR}/../docs/lib"
+readonly LIB_DOCS_DIR="${SCRIPT_DIR}/../docs/_lib"
+
+function front_matter() {
+  local title="${1?Must provide title}"
+  cat <<EOF
+---
+title: "${title} – lib-bash"
+permalink: /lib/${title}/
+---
+EOF
+}
 
 function main() {
   rm -rf "${LIB_DOCS_DIR}"
@@ -34,8 +44,10 @@ function main() {
   for lib in "${LIB_BASH_DIR}"/lib_*.sh; do
     local lib_name
     lib_name="$(basename "${lib}")"
-    local target="${LIB_DOCS_DIR}/${lib_name%.sh}.md"
-    "${DOC_SINGLE}" "${lib}" >"${target}"
+    lib_title="${lib_name%.sh}"
+    local target="${LIB_DOCS_DIR}/${lib_title}.md"
+    front_matter "${lib_title}" >"${target}"
+    "${DOC_SINGLE}" "${lib}" >>"${target}"
   done
 }
 

docs/README.md

@@ -3,3 +3,11 @@
 ![Lib-Bash Decorative Image](img/LibBashGitHubSocialPreview.jpg)
 
 A set of libraries to use from within your Bash scripts.
+
+## Libraries
+
+{% for lib in site.lib %}
+
+- [{{ lib.title }}]({{ lib.url | relative_url }})
+
+{% endfor %}

docs/_config.yml

@@ -0,0 +1,38 @@
+# _config.yml
+title: lib-bash – Bash Libraries
+description: Documentation generated via Jekyll GitHub Action
+theme: jekyll-theme-minimal
+
+# Other configurations
+markdown: kramdown
+strict_front_matter: true
+collections:
+  lib:
+    output: true
+    sort_by: title
+    permalink: /:collection/:path/
+#plugins:
+#  - jekyll-feed
+#  - jekyll-seo-tag
+#  - jekyll-sitemap
+#  - jekyll-remote-theme
+#  - jekyll-redirect-from
+#  - jekyll-paginate
+#  - jekyll-archives
+#  - jekyll-github-metadata
+#  - jekyll-avatar
+#  - jekyll-mentions
+#  - jekyll-include-cache
+#  - jekyll-default-layout
+#  - jekyll-default-mimetype
+#  - jekyll-optional-front-matter
+#  - jekyll-readme-index
+#  - jekyll-relative-links
+#  - jekyll-remote-theme
+#  - jekyll-titles-from-headings
+#  - jekyll-redirect-from
+#  - jekyll-optional-front-matter
+#  - jekyll-remote-theme
+#  - jekyll-titles-from-headings
+#  - jekyll-redirect-from
+#

docs/lib/lib_console.md docs/_lib/lib_console.mddocs/lib/lib_console.md renamed to docs/_lib/lib_console.md

@@ -1,3 +1,7 @@
+---
+title: "lib_console – lib-bash"
+permalink: /lib/lib_console/
+---
 
 # lib_console.sh
 

docs/lib/lib_gnucompat.md docs/_lib/lib_gnucompat.mddocs/lib/lib_gnucompat.md renamed to docs/_lib/lib_gnucompat.md

@@ -1,3 +1,7 @@
+---
+title: "lib_gnucompat – lib-bash"
+permalink: /lib/lib_gnucompat/
+---
 
 # GNU-Tools Compatibility Layer
 

docs/lib/lib_init.md docs/_lib/lib_init.mddocs/lib/lib_init.md renamed to docs/_lib/lib_init.md

@@ -1,3 +1,7 @@
+---
+title: "lib_init – lib-bash"
+permalink: /lib/lib_init/
+---
 
 # lib_init.sh
 

docs/lib/lib_scriptinfo.md docs/_lib/lib_scriptinfo.mddocs/lib/lib_scriptinfo.md renamed to docs/_lib/lib_scriptinfo.md

@@ -1,3 +1,7 @@
+---
+title: "lib_scriptinfo – lib-bash"
+permalink: /lib/lib_scriptinfo/
+---
 
 # lib_scriptinfo.sh