Touchup markup guide to better reflect current feature set (#115)

elastic · Dec 17, 2024 · 3311063 · 3311063
1 parent 880b7b1
commit 3311063
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 158 deletions.
diff --git a/docs/source/markup/admonitions.md b/docs/source/markup/admonitions.md
@@ -46,10 +46,10 @@ Here is a tip.
 
 ## Collapsible admonitions
 
-You can use `:class: dropdown` to make an admonition collapsible.
+You can use `:open: <bool>` to make an admonition collapsible.
 
 ```{note}
-:class: dropdown
+:open: 
 
 Longer content can be collapsed to take less space.
 

diff --git a/docs/source/markup/applies.md b/docs/source/markup/applies.md
@@ -49,6 +49,7 @@ Are equivalent, note `all` just means we won't be rendering the version portion
 
 
 ## This section has its own applies annotations
+
 :::{applies}
 :stack: unavailable
 :serverless: tech-preview

diff --git a/docs/source/markup/cards_grids.md b/docs/source/markup/cards_grids.md
diff --git a/docs/source/markup/images.md b/docs/source/markup/images.md
@@ -37,3 +37,21 @@ We can use the `figure-md` directive to add caption to an image.
 
 This is a caption in **Markdown**
 ```
+
+
+
+```{directive} arguments
+:option: value
+
+# hello world
+[a link](https://www.google.com] with  **bold** text
+```
+
+
+
+:::{directive} arguments
+:option: value
+
+# hello world
+[a link](https://www.google.com] with  **bold** text
+:::
diff --git a/docs/source/markup/notebook.ipynb b/docs/source/markup/notebook.ipynb
diff --git a/docs/source/markup/rst.rst b/docs/source/markup/rst.rst
diff --git a/docs/source/markup/rst_in_markdown.md b/docs/source/markup/rst_in_markdown.md
diff --git a/docs/source/markup/sundries.md b/docs/source/markup/sundries.md
@@ -25,11 +25,6 @@ Here is a quote. The attribution is added using the block attribute `attribution
 {attribution="Hamlet act 4, Scene 5"}
 > We know what we are, but know not what we may be.
 
-## Task lists
-
-- [ ] An item that needs doing
-- [x] An item that is complete
-
 ## Line breaks
 
 You can break a paraghraph \

diff --git a/docs/source/markup/yaml_to_markdown.md b/docs/source/markup/yaml_to_markdown.md
@@ -1,9 +1,8 @@
 ---
-title: Kibana Configuration
+title: Generate Settings References
+navigation_title: Settings References
 ---
 
 
-```{yaml-to-md}
-:yaml: _static/yaml/settings.yaml
-:template: _static/templates/settings.jinja
+```{settings} /elastic/reference/kibana-alerting-action-settings.yml
 ```
diff --git a/src/Elastic.Markdown/Myst/Directives/AdmonitionBlock.cs b/src/Elastic.Markdown/Myst/Directives/AdmonitionBlock.cs
@@ -33,20 +33,13 @@ public string Title
 
 	public override void FinalizeAndValidate(ParserContext context)
 	{
-		Classes = Properties.GetValueOrDefault("class");
 		CrossReferenceName = Properties.GetValueOrDefault("name");
 		DropdownOpen = PropBool("open");
+		if (DropdownOpen.HasValue)
+			Classes = "dropdown";
 	}
 }
 
 
 public class DropdownBlock(DirectiveBlockParser parser, Dictionary<string, string> properties, ParserContext context)
-	: AdmonitionBlock(parser, "admonition", properties, context)
-{
-	// ReSharper disable once RedundantOverriddenMember
-	public override void FinalizeAndValidate(ParserContext context)
-	{
-		base.FinalizeAndValidate(context);
-		Classes = $"dropdown {Classes}";
-	}
-}
+	: AdmonitionBlock(parser, "admonition", properties, context);