Add the ability to pull in docs from valkey-doc (valkey-io#22)

* adds support for pulling in valkey-docs Signed-off-by: Kyle J. Davis <[email protected]> * one more change to layout Signed-off-by: Kyle J. Davis <[email protected]> --------- Signed-off-by: Kyle J. Davis <[email protected]>
AMoo-Miki · Apr 10, 2024 · 19d2253 · 19d2253
1 parent d2a0899
commit 19d2253
Show file tree

Hide file tree

Showing 6 changed files with 39 additions and 2 deletions.
diff --git a/.github/workflows/deply.yml b/.github/workflows/deply.yml
@@ -27,6 +27,7 @@ jobs:
           mkdir _data/commands _includes/commands
           ln -s $(pwd)/_submodules/valkey/src/commands $(pwd)/_data/commands/latest
           ln -s $(pwd)/_submodules/valkey-doc/commands $(pwd)/_includes/commands/latest
+          ln -s $(pwd)/_submodules/valkey-doc/docs $(pwd)/_includes/docs
       - name: Setup Ruby
         uses: ruby/setup-ruby@8575951200e472d5f2d95c625da0c7bec8217c42 # v1.161.0
         with:

diff --git a/.gitignore b/.gitignore
@@ -5,4 +5,5 @@ _site
 vendor
 .DS_Store
 /_data/commands/
-/_includes/commands/
+/_includes/commands/
+/_includes/docs/
diff --git a/_includes/docs b/_includes/docs
@@ -0,0 +1 @@
+../_submodules/valkey-doc/docs/
diff --git a/_layouts/doc-import.html b/_layouts/doc-import.html
@@ -0,0 +1,29 @@
+---
+layout: default
+---
+{%- assign  primary_title = page.primary_title -%}
+{%- comment -%}
+    This template pulls in the file from `source` in the front matter.
+
+    It detects if the script starts with front matter (delimited by `---`) by splitting and looking for the delimiter at the start of the file.
+    If the delimter is detected at the top of the file, it skips the the 3rd (zero based: 2) element and iterates over the remain sections.
+    If there delmiter is not detected (no front matter) it swallows the the whole file and markdownify's it.
+
+{%- endcomment -%}
+{%- capture md -%}{% include {{ page.source }} %}{%- endcapture -%}
+{%- assign stripped_front_matter = md | split: "---" -%}
+{%- include page_title.html -%}
+<div class="width-limiter">
+    <main class="container">
+        {%- if stripped_front_matter[0].size == 0 -%}
+            {%- for item in stripped_front_matter offset:2 -%}
+                {{ item | markdownify }}
+                {%- if forloop.last == false -%}
+                    <hr />
+                {%- endif -%}
+            {%- endfor -%}
+        {%- else -%}
+            {{ md | markdownify }}
+        {%- endif -%}
+    </main>
+</div>
diff --git a/_submodules/valkey-doc b/_submodules/valkey-doc
diff --git a/docs/management/persistence.md b/docs/management/persistence.md
@@ -0,0 +1,5 @@
+---
+layout: doc-import
+primary_title: Persistence
+source: "/docs/management/persistence.md"
+---
+129 −129		docs/connect/cli.md
+43 −43		docs/management/debugging.md
+66 −113		docs/management/persistence.md
+49 −68		docs/management/security/acl.md
+14 −20		docs/manual/keyspace-notifications.md