docs: improve rendering of specification files on GH pages

Fixes coreos#183
Okeanos · Apr 1, 2023 · 77148b9 · 77148b9
1 parent b28e42e
commit 77148b9
Show file tree

Hide file tree

Showing 22 changed files with 30 additions and 1 deletion.
diff --git a/docs/_sass/custom/custom.scss b/docs/_sass/custom/custom.scss
@@ -0,0 +1,9 @@
+#spec-docs ~ ul {
+  ul {
+    border-left: 1px solid $grey-lt-300;
+  }
+
+  li::before {
+    margin-left: -0.8em;
+  }
+}
diff --git a/docs/config-fcos-v1_0.md b/docs/config-fcos-v1_0.md
@@ -5,6 +5,7 @@ nav_order: 49
 ---
 
 # Fedora CoreOS Specification v1.0.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_1.md b/docs/config-fcos-v1_1.md
@@ -5,6 +5,7 @@ nav_order: 48
 ---
 
 # Fedora CoreOS Specification v1.1.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_2.md b/docs/config-fcos-v1_2.md
@@ -5,6 +5,7 @@ nav_order: 47
 ---
 
 # Fedora CoreOS Specification v1.2.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_3.md b/docs/config-fcos-v1_3.md
@@ -5,6 +5,7 @@ nav_order: 46
 ---
 
 # Fedora CoreOS Specification v1.3.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_4.md b/docs/config-fcos-v1_4.md
@@ -5,6 +5,7 @@ nav_order: 45
 ---
 
 # Fedora CoreOS Specification v1.4.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_5.md b/docs/config-fcos-v1_5.md
@@ -5,6 +5,7 @@ nav_order: 44
 ---
 
 # Fedora CoreOS Specification v1.5.0
+<div id="spec-docs"></div>
 
 The Fedora CoreOS configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-fcos-v1_6-exp.md b/docs/config-fcos-v1_6-exp.md
@@ -5,6 +5,7 @@ nav_order: 50
 ---
 
 # Fedora CoreOS Specification v1.6.0-experimental
+<div id="spec-docs"></div>
 
 **Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
 

diff --git a/docs/config-flatcar-v1_0.md b/docs/config-flatcar-v1_0.md
@@ -5,6 +5,7 @@ nav_order: 99
 ---
 
 # Flatcar Specification v1.0.0
+<div id="spec-docs"></div>
 
 The Flatcar configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-flatcar-v1_1.md b/docs/config-flatcar-v1_1.md
@@ -5,6 +5,7 @@ nav_order: 98
 ---
 
 # Flatcar Specification v1.1.0
+<div id="spec-docs"></div>
 
 The Flatcar configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-flatcar-v1_2-exp.md b/docs/config-flatcar-v1_2-exp.md
@@ -5,6 +5,7 @@ nav_order: 100
 ---
 
 # Flatcar Specification v1.2.0-experimental
+<div id="spec-docs"></div>
 
 **Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
 

diff --git a/docs/config-openshift-v4_10.md b/docs/config-openshift-v4_10.md
@@ -5,6 +5,7 @@ nav_order: 147
 ---
 
 # OpenShift Specification v4.10.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-openshift-v4_11.md b/docs/config-openshift-v4_11.md
@@ -5,6 +5,7 @@ nav_order: 146
 ---
 
 # OpenShift Specification v4.11.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-openshift-v4_12.md b/docs/config-openshift-v4_12.md
@@ -5,6 +5,7 @@ nav_order: 145
 ---
 
 # OpenShift Specification v4.12.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-openshift-v4_13.md b/docs/config-openshift-v4_13.md
@@ -5,6 +5,7 @@ nav_order: 144
 ---
 
 # OpenShift Specification v4.13.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-openshift-v4_14-exp.md b/docs/config-openshift-v4_14-exp.md
@@ -5,6 +5,7 @@ nav_order: 150
 ---
 
 # OpenShift Specification v4.14.0-experimental
+<div id="spec-docs"></div>
 
 **Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
 

diff --git a/docs/config-openshift-v4_8.md b/docs/config-openshift-v4_8.md
@@ -5,6 +5,7 @@ nav_order: 149
 ---
 
 # OpenShift Specification v4.8.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-openshift-v4_9.md b/docs/config-openshift-v4_9.md
@@ -5,6 +5,7 @@ nav_order: 148
 ---
 
 # OpenShift Specification v4.9.0
+<div id="spec-docs"></div>
 
 The OpenShift configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-r4e-v1_0.md b/docs/config-r4e-v1_0.md
@@ -5,6 +5,7 @@ nav_order: 199
 ---
 
 # RHEL for Edge Specification v1.0.0
+<div id="spec-docs"></div>
 
 The RHEL for Edge configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-r4e-v1_1.md b/docs/config-r4e-v1_1.md
@@ -5,6 +5,7 @@ nav_order: 198
 ---
 
 # RHEL for Edge Specification v1.1.0
+<div id="spec-docs"></div>
 
 The RHEL for Edge configuration is a YAML document conforming to the following specification, with **_italicized_** entries being optional:
 

diff --git a/docs/config-r4e-v1_2-exp.md b/docs/config-r4e-v1_2-exp.md
@@ -5,6 +5,7 @@ nav_order: 200
 ---
 
 # RHEL for Edge Specification v1.2.0-experimental
+<div id="spec-docs"></div>
 
 **Note: This configuration is experimental and has not been stabilized. It is subject to change without warning or announcement.**
 

diff --git a/docs/release-notes.md b/docs/release-notes.md
@@ -20,7 +20,7 @@ nav_order: 9
 
 ### Docs changes
 
-
+- Improve rendering of specification files on GH pages
 
 ## Butane 0.18.0 (2023-03-24)