From 3c01f2c82276579c93d36c161b4d860cabdfe2a6 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Tue, 2 Apr 2024 21:19:41 -0700 Subject: [PATCH 1/7] Update markdown-demo-v2.md --- docs/gemstones/markdown-demo-v2.md | 35 ++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index f957eb6c01..3d87128bef 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -11,6 +11,11 @@ tags: # Overview +## Background +* Use [Markdown](https://daringfireball.net/projects/markdown). +* If you don't know Markdown - Learn Markdown; seriously it might be one of the + most important languages you will learn over the years. + !!! WARNING Do not take anything you may read in this document seriously. @@ -53,10 +58,33 @@ At other times, you need bulleted or numbered lists: And you could need an admonition: +### Admonitions + +Admonitions, also known as call-outs, are an excellent choice for including side content without significantly interrupting the document flow. Material for MkDocs provides several different types of admonitions and allows for the inclusion and nesting of arbitrary content. + !!! TIP Pencils and staplers are really old-school. +#### Usage +Admonitions follow a simple syntax: a block starts with !!!, followed by a single keyword used as a type qualifier. The content of the block follows on the next line, indented by four spaces: + +!!! note + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + +#### Changing the title +By default, the title will equal the type qualifier in titlecase. However, it can be changed by adding a quoted string containing valid Markdown (including links, formatting, ...) after the type qualifier: + +!!! note "Phasellus posuere in sem ut cursus" + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod + nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor + massa, nec semper lorem quam in massa. + + More times than not, when a command has multiple options, or you need to list specifics, you might want to use a table to identify things: | Tool | Use | Additional Information | @@ -66,3 +94,10 @@ More times than not, when a command has multiple options, or you need to list sp | stylus | writing or printing on an electronic device | sometimes replaced by a keyboard | | keyboard | writing or printing on an electronic device | never replaced - used until full of food crumbs | | notepad | take notes | substitute for a sometimes-faulty memory | + +::: mermaid +pie title Fishermans in countries + "Norway" : 684 + "Sweeden" : 234 + "Switzerland" : 10 +::: From 23998cc83a236154fd6ed72da7297c71d599a310 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Tue, 2 Apr 2024 21:26:03 -0700 Subject: [PATCH 2/7] cleanup of breaking mermaid bits --- docs/gemstones/markdown-demo-v2.md | 7 ------- 1 file changed, 7 deletions(-) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 3d87128bef..8352f98800 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -94,10 +94,3 @@ More times than not, when a command has multiple options, or you need to list sp | stylus | writing or printing on an electronic device | sometimes replaced by a keyboard | | keyboard | writing or printing on an electronic device | never replaced - used until full of food crumbs | | notepad | take notes | substitute for a sometimes-faulty memory | - -::: mermaid -pie title Fishermans in countries - "Norway" : 684 - "Sweeden" : 234 - "Switzerland" : 10 -::: From 4bcb4fa10226088ff248f95cd26ffdf80a487ad5 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Wed, 3 Apr 2024 04:32:56 +0000 Subject: [PATCH 3/7] added to metadata --- docs/gemstones/markdown-demo-v2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 8352f98800..17e3db6314 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -1,7 +1,7 @@ --- title: Markdown Demo author: Einstein -contributors: Dr. Ben Dover, Sweet Gypsy Rose +contributors: Dr. Ben Dover, Sweet Gypsy Rose, fusion94 tested_with: 8.5 tags: - sample From c50daebf6bfb81c2cb55a2f73c0e502ad5b41f24 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Wed, 3 Apr 2024 09:26:30 -0700 Subject: [PATCH 4/7] Update docs/gemstones/markdown-demo-v2.md Co-authored-by: Antoine Le Morvan --- docs/gemstones/markdown-demo-v2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 17e3db6314..73e22e0226 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -12,6 +12,7 @@ tags: # Overview ## Background + * Use [Markdown](https://daringfireball.net/projects/markdown). * If you don't know Markdown - Learn Markdown; seriously it might be one of the most important languages you will learn over the years. From 8f5a2ce2931cc6156f21a976d913b1448c95555f Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Wed, 3 Apr 2024 09:26:42 -0700 Subject: [PATCH 5/7] Update docs/gemstones/markdown-demo-v2.md Co-authored-by: Antoine Le Morvan --- docs/gemstones/markdown-demo-v2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 73e22e0226..5ba1c8ab99 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -68,6 +68,7 @@ Admonitions, also known as call-outs, are an excellent choice for including side Pencils and staplers are really old-school. #### Usage + Admonitions follow a simple syntax: a block starts with !!!, followed by a single keyword used as a type qualifier. The content of the block follows on the next line, indented by four spaces: !!! note From 6e267deec54854a064fe1b099fe0c4c41f634904 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Wed, 3 Apr 2024 09:26:47 -0700 Subject: [PATCH 6/7] Update docs/gemstones/markdown-demo-v2.md Co-authored-by: Antoine Le Morvan --- docs/gemstones/markdown-demo-v2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 5ba1c8ab99..0e0fcf27f5 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -69,7 +69,7 @@ Admonitions, also known as call-outs, are an excellent choice for including side #### Usage -Admonitions follow a simple syntax: a block starts with !!!, followed by a single keyword used as a type qualifier. The content of the block follows on the next line, indented by four spaces: +Admonitions follow a simple syntax: a block starts with `!!!`, followed by a single keyword used as a type qualifier. The content of the block follows on the next line, indented by four spaces: !!! note From d60d91583418cd476da1aa185e429b9cc50dbff6 Mon Sep 17 00:00:00 2001 From: Tony Guntharp Date: Wed, 3 Apr 2024 09:26:54 -0700 Subject: [PATCH 7/7] Update docs/gemstones/markdown-demo-v2.md Co-authored-by: Antoine Le Morvan --- docs/gemstones/markdown-demo-v2.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 0e0fcf27f5..5e826aa235 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -78,6 +78,7 @@ Admonitions follow a simple syntax: a block starts with `!!!`, followed by a sin massa, nec semper lorem quam in massa. #### Changing the title + By default, the title will equal the type qualifier in titlecase. However, it can be changed by adding a quoted string containing valid Markdown (including links, formatting, ...) after the type qualifier: !!! note "Phasellus posuere in sem ut cursus"