docs: Add custom genestack admonition (rackerlabs#618)

* docs: Add custom genestack admonition type for specific references to the Genestack way... Signed-off-by: Ken Crandall <[email protected]> * fix: fix trailing whitespace (of course) Signed-off-by: Ken Crandall <[email protected]> --------- Signed-off-by: Ken Crandall <[email protected]>
OpenStackKen · Dec 10, 2024 · 2b65c46 · 2b65c46
1 parent 6aabdf5
commit 2b65c46
Show file tree

Hide file tree

Showing 4 changed files with 237 additions and 0 deletions.
diff --git a/docs/admonition-test.md b/docs/admonition-test.md
@@ -0,0 +1,15 @@
+# Custom Genestack Admonition
+
+There is now a 'genestack' admonition type:
+
+```
+!!! genestack
+    [Genestack](https://github.com/rackerlabs/genestack){:target="_blank"}
+    is a cool new project!
+```
+
+It renders like this:
+
+!!! genestack
+    [Genestack](https://github.com/rackerlabs/genestack){:target="_blank"}
+    is a cool new project!
diff --git a/docs/assets/images/genestack-mono.svg b/docs/assets/images/genestack-mono.svg
diff --git a/docs/overrides/stylesheets/admonition.css b/docs/overrides/stylesheets/admonition.css
@@ -0,0 +1,25 @@
+
+/*
+Custom Genestack Admonition Type
+*/
+
+:root {
+    --md-admonition-icon--genestack: url('/assets/images/genestack-mono.svg');
+}
+
+.md-typeset .admonition.genestack,
+.md-typeset details.genestack {
+    border-color: rgb(158, 0, 0);
+}
+
+.md-typeset .genestack>.admonition-title,
+.md-typeset .genestack>summary {
+    background-color: rgba(158, 0, 0, 0.1);
+}
+
+.md-typeset .genestack>.admonition-title::before,
+.md-typeset .genestack>summary::before {
+    background-color: rgb(158, 0, 0);
+    -webkit-mask-image: var(--md-admonition-icon--genestack);
+    mask-image: var(--md-admonition-icon--genestack);
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -83,6 +83,7 @@ extra:
 
 extra_css:
   - overrides/stylesheets/adr.css
+  - overrides/stylesheets/admonition.css
 
 plugins:
   - search