From 58c4bf41753787a79b07fa3f0cdf3ff30c943119 Mon Sep 17 00:00:00 2001 From: Mark Michaelis Date: Wed, 12 Mar 2025 21:25:02 +0100 Subject: [PATCH 1/2] docs(lib): Prepare "lib" Collection For collections, they need to be a placed into a folder with an underscore. --- bin/docs.sh | 2 +- docs/{lib => _lib}/lib_console.md | 0 docs/{lib => _lib}/lib_gnucompat.md | 0 docs/{lib => _lib}/lib_init.md | 0 docs/{lib => _lib}/lib_scriptinfo.md | 0 5 files changed, 1 insertion(+), 1 deletion(-) rename docs/{lib => _lib}/lib_console.md (100%) rename docs/{lib => _lib}/lib_gnucompat.md (100%) rename docs/{lib => _lib}/lib_init.md (100%) rename docs/{lib => _lib}/lib_scriptinfo.md (100%) diff --git a/bin/docs.sh b/bin/docs.sh index 57e605f..b28c48d 100755 --- a/bin/docs.sh +++ b/bin/docs.sh @@ -23,7 +23,7 @@ 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 main() { rm -rf "${LIB_DOCS_DIR}" diff --git a/docs/lib/lib_console.md b/docs/_lib/lib_console.md similarity index 100% rename from docs/lib/lib_console.md rename to docs/_lib/lib_console.md diff --git a/docs/lib/lib_gnucompat.md b/docs/_lib/lib_gnucompat.md similarity index 100% rename from docs/lib/lib_gnucompat.md rename to docs/_lib/lib_gnucompat.md diff --git a/docs/lib/lib_init.md b/docs/_lib/lib_init.md similarity index 100% rename from docs/lib/lib_init.md rename to docs/_lib/lib_init.md diff --git a/docs/lib/lib_scriptinfo.md b/docs/_lib/lib_scriptinfo.md similarity index 100% rename from docs/lib/lib_scriptinfo.md rename to docs/_lib/lib_scriptinfo.md From ad64578458ce8de5283cf6245dc23c5e5fa5bef3 Mon Sep 17 00:00:00 2001 From: Mark Michaelis Date: Wed, 12 Mar 2025 21:41:18 +0100 Subject: [PATCH 2/2] ci(pages): Adapting Pages Generation Introducing lib collection. --- bin/docs.sh | 16 ++++++++++++++-- docs/README.md | 8 ++++++++ docs/_config.yml | 38 +++++++++++++++++++++++++++++++++++++ docs/_lib/lib_console.md | 4 ++++ docs/_lib/lib_gnucompat.md | 4 ++++ docs/_lib/lib_init.md | 4 ++++ docs/_lib/lib_scriptinfo.md | 4 ++++ 7 files changed, 76 insertions(+), 2 deletions(-) create mode 100644 docs/_config.yml diff --git a/bin/docs.sh b/bin/docs.sh index b28c48d..e2030dd 100755 --- a/bin/docs.sh +++ b/bin/docs.sh @@ -25,6 +25,16 @@ readonly DOC_SINGLE="${SCRIPT_DIR}/doc-single.sh" readonly LIB_BASH_DIR="${SCRIPT_DIR}/.." readonly LIB_DOCS_DIR="${SCRIPT_DIR}/../docs/_lib" +function front_matter() { + local title="${1?Must provide title}" + cat <"${target}" + lib_title="${lib_name%.sh}" + local target="${LIB_DOCS_DIR}/${lib_title}.md" + front_matter "${lib_title}" >"${target}" + "${DOC_SINGLE}" "${lib}" >>"${target}" done } diff --git a/docs/README.md b/docs/README.md index bed7757..e9d4540 100644 --- a/docs/README.md +++ b/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 %} diff --git a/docs/_config.yml b/docs/_config.yml new file mode 100644 index 0000000..70c33a8 --- /dev/null +++ b/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 +# diff --git a/docs/_lib/lib_console.md b/docs/_lib/lib_console.md index f9ec25e..e08697a 100644 --- a/docs/_lib/lib_console.md +++ b/docs/_lib/lib_console.md @@ -1,3 +1,7 @@ +--- +title: "lib_console – lib-bash" +permalink: /lib/lib_console/ +--- # lib_console.sh diff --git a/docs/_lib/lib_gnucompat.md b/docs/_lib/lib_gnucompat.md index 64bc5aa..140d21a 100644 --- a/docs/_lib/lib_gnucompat.md +++ b/docs/_lib/lib_gnucompat.md @@ -1,3 +1,7 @@ +--- +title: "lib_gnucompat – lib-bash" +permalink: /lib/lib_gnucompat/ +--- # GNU-Tools Compatibility Layer diff --git a/docs/_lib/lib_init.md b/docs/_lib/lib_init.md index fad6e86..b5856cc 100644 --- a/docs/_lib/lib_init.md +++ b/docs/_lib/lib_init.md @@ -1,3 +1,7 @@ +--- +title: "lib_init – lib-bash" +permalink: /lib/lib_init/ +--- # lib_init.sh diff --git a/docs/_lib/lib_scriptinfo.md b/docs/_lib/lib_scriptinfo.md index 5a627e5..258cd5e 100644 --- a/docs/_lib/lib_scriptinfo.md +++ b/docs/_lib/lib_scriptinfo.md @@ -1,3 +1,7 @@ +--- +title: "lib_scriptinfo – lib-bash" +permalink: /lib/lib_scriptinfo/ +--- # lib_scriptinfo.sh