From b243a2d235f79bc4c252d16bb5d63851560e2a2e Mon Sep 17 00:00:00 2001 From: Ganna Zhyrnova <112796922+gannazhyrnova@users.noreply.github.com> Date: Fri, 5 Apr 2024 16:26:29 +0300 Subject: [PATCH 1/2] markdown-demo-v2.md @sspencerwire, please add normal (real author and contributor names to this file). In the documents, we use real names, not nicknames. --- docs/gemstones/markdown-demo-v2.md | 22 ++++++++-------------- 1 file changed, 8 insertions(+), 14 deletions(-) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index 5e826aa235..dbd0c43c94 100644 --- a/docs/gemstones/markdown-demo-v2.md +++ b/docs/gemstones/markdown-demo-v2.md @@ -14,28 +14,22 @@ tags: ## 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. +* Knowledge of markdown. -!!! WARNING - Do not take anything you may read in this document seriously. - -As you can tell by reading, this is a pretty silly example, designed to be used to test some translation issues that we are having. But because the problems have not yet been solved we are going to modify the file a little bit here and there to see the effect it has. It's fun to write though! - -This guide demos popular Markdown tags used on [https://docs.rockylinux.org](https://docs.rockylinux.org) also includes the admonitions tag, which is not part of the standard Markdown tags. +This guide demonstrates popular Markdown tags used on [https://docs.rockylinux.org](https://docs.rockylinux.org) and also includes the admonitions tag, which is not part of the standard Markdown tags. ## The Demo > This is a quote example. Nicely formatted. -Sometimes you will see things like _this_. +Sometimes, you will see things like _this_. How about a little **bold face** -Most of the time, it straight text like this. +Most of the time, it is straight text like this. -Sometimes you need to show a `command` +Sometimes, you need to show a `command` Or multiple commands: @@ -61,11 +55,11 @@ 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. +Admonitions, also called out, are an excellent choice for including side content without significantly interrupting the document flow. Material for MkDocs provides several types of admonitions and allows for the inclusion and nesting of arbitrary content. !!! TIP - Pencils and staplers are really old-school. + Pencils and staplers are old-school. #### Usage @@ -88,7 +82,7 @@ By default, the title will equal the type qualifier in titlecase. However, it ca 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: +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 | | -------- | ------------------------------------------- | ----------------------------------------------- | From 0a7a58da317abc9fe2645d2b9837e9a861ea731b Mon Sep 17 00:00:00 2001 From: sspencerwire Date: Fri, 5 Apr 2024 11:00:36 -0500 Subject: [PATCH 2/2] Update markdown-demo-v2.md real names for @gannazhyrnova --- docs/gemstones/markdown-demo-v2.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/gemstones/markdown-demo-v2.md b/docs/gemstones/markdown-demo-v2.md index dbd0c43c94..4a9712045d 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, fusion94 +author: Steven Spencer +contributors: Wale Soyinka, fusion94 tested_with: 8.5 tags: - sample