Use mdbook-admonish to visualize bad/good examples

resolves #2

Co-authored-by: meator <[email protected]>

Author: tranzystorekk

book.toml

@@ -14,4 +14,7 @@ git-repository-url = "https://github.com/meator/xbps-src-tutorials"
 command = "mdbook-toc"
 renderer = ["html"]
 
+[preprocessor.admonish]
+command = "mdbook-admonish"
+
 #[output.linkcheck]

src/packaging-bat.md

@@ -32,9 +32,14 @@ of it is in their repository: <https://github.com/sharkdp/bat>
 
    Remember that plaintext changelogs are preferred:
 
-   Bad: `changelog=https://github.com/sharkdp/bat/blob/master/CHANGELOG.md`
+   ~~~admonish failure title="Bad"
+  `changelog=https://github.com/sharkdp/bat/blob/master/CHANGELOG.md`
+   ~~~
+
+   ~~~admonish success title="Good"
+  `changelog=https://raw.githubusercontent.com/sharkdp/bat/master/CHANGELOG.md`
+   ~~~
 
-   Good: `https://raw.githubusercontent.com/sharkdp/bat/master/CHANGELOG.md`
 - `distfiles`: `bat`'s release has a lot of files in it:
 
    ![bat release](images/bat/release.png)
@@ -45,9 +50,13 @@ of it is in their repository: <https://github.com/sharkdp/bat>
 
    Don't forget to replace the version with `${version}`:
 
-   Bad: `https://github.com/sharkdp/bat/archive/refs/tags/v0.24.0.tar.gz`
+   ~~~admonish failure title="Bad"
+  `https://github.com/sharkdp/bat/archive/refs/tags/v0.24.0.tar.gz`
+   ~~~
 
-   Good: `https://github.com/sharkdp/bat/archive/refs/tags/v${version}.tar.gz`
+   ~~~admonish success title="Good"
+  `https://github.com/sharkdp/bat/archive/refs/tags/v${version}.tar.gz`
+   ~~~
 
 ## Creating the template
 
@@ -459,7 +468,7 @@ It also includes a patch to make the XBPS version of `libgit2` work in `bat`.
 ## What now?
 You might be wondering how the SHLIB detection works. This is best explained
 while packaging a library. The next part of this tutorial packages
-[`oiguruma`](https://github.com/kkos/oniguruma) a dependency of `bat`:
+[`oniguruma`](https://github.com/kkos/oniguruma) a dependency of `bat`:
 
 [Packaging oniguruma](packaging-oniguruma.md)
 

src/packaging-j4-dmenu-desktop.md

@@ -187,7 +187,7 @@ CONTRIBUTING](https://github.com/void-linux/void-packages/blob/master/CONTRIBUTI
 
 Namely **<span style="color:red"><ins>software without a release or tag</ins></span>,
 cryptocurrency packages, browser forks, simple shell scripts, themes, prebuilt
-packages** and more won't likely get accepted. I recommend you to read the
+packages** and more won't likely get accepted. I recommend you read the
 requirements in full linked above.
 
 ### Has it been packaged already?
@@ -420,13 +420,18 @@ explanation:
 
    The version shouldn't contain unnecessary characters:
 
-   Bad: `version=r2.18`
+   ~~~admonish failure title="Bad"
+  `version=r2.18`
+  or
+  `version=v0.24.0`
+   ~~~
 
-   Good: `version=2.18`
+   ~~~admonish success title="Good"
+  `version=2.18`
+  or
+  `version=0.24.0`
+   ~~~
 
-   Bad: `version=v0.24.0`
-
-   Good: `version=0.24.0`
 - `revision` = revision of the package; it can sometimes happen that the package
                has to be changed without updating it to for example fix some
                problem with the currently packaged version; `revision` is used
@@ -444,13 +449,15 @@ explanation:
                  characters, it mustn't start with an article and it should
                  start with an uppercase letter:
 
-   Bad: `short_desc="A desktop menu"`
-
-   Good: `short_desc="Desktop menu"`
-
-   Bad: `short_desc="desktop menu"`
+   ~~~admonish failure title="Bad"
+  `short_desc="A desktop menu"`
+  or
+  `short_desc="desktop menu"`
+   ~~~
 
-   Good: `short_desc="Desktop menu"`
+   ~~~admonish success title="Good"
+  `short_desc="Desktop menu"`
+   ~~~
 
    A good choice for `short_desc` is the GitHub short description (if the
    packaged project has one):
@@ -500,9 +507,13 @@ explanation:
 
   You can then copy the link.
 
-  Bad: `https://github.com/enkore/j4-dmenu-desktop/blob/develop/CHANGELOG`
+  ~~~admonish failure title="Bad"
+  `https://github.com/enkore/j4-dmenu-desktop/blob/develop/CHANGELOG`
+  ~~~
 
-  Good: `https://raw.githubusercontent.com/enkore/j4-dmenu-desktop/develop/CHANGELOG`
+  ~~~admonish success title="Good"
+  `https://raw.githubusercontent.com/enkore/j4-dmenu-desktop/develop/CHANGELOG`
+  ~~~
 
 We need to gather all of this information about `j4-dmenu-desktop` to be able to
 package it.

src/packaging-oniguruma.md

@@ -30,11 +30,13 @@ sed -i /oniguruma/d common/shlibs
 
   This link includes `${version}` twice, so it has to be substituted twice:
 
-  Bad:
+  ~~~admonish failure title="Bad"
   `distfiles="https://github.com/kkos/oniguruma/releases/download/v6.9.9/onig-${version}.tar.gz"`
+  ~~~
 
-  Good:
+  ~~~admonish success title="Good"
   `distfiles="https://github.com/kkos/oniguruma/releases/download/v${version}/onig-${version}.tar.gz"`
+  ~~~
 
 ## A word about subpackages
 A package can have