Update doc theme and use more common admonition syntax

Author: facelessuser

docs/src/markdown/about/changelog.md

@@ -188,13 +188,12 @@
 
 ## 4.7
 
-/// warning | Warning
-Backrefs 4.2.0 has deprecated the shorthand references for alphabetic character groups in `re` search patterns:
-`\l`, `\L`, `\c`, and `\C`. Instead you should use: `[[:lower:]]`, `[[:^lower:]]`, `[[:upper:]]`, and `[[:^upper:]]`
-respectively. While the references have only been deprecated, and are technically still available, a future version
-of Backrefs will remove them entirely at some point. It is recommended to transition now so as not to be caught
-unawares.
-///
+> [!warning] Warning
+> Backrefs 4.2.0 has deprecated the shorthand references for alphabetic character groups in `re` search patterns:
+> `\l`, `\L`, `\c`, and `\C`. Instead you should use: `[[:lower:]]`, `[[:^lower:]]`, `[[:upper:]]`, and `[[:^upper:]]`
+> respectively. While the references have only been deprecated, and are technically still available, a future version
+> of Backrefs will remove them entirely at some point. It is recommended to transition now so as not to be caught
+> unawares.
 
 -   **NEW**: Add `col0` variable for editor configuration to allow for using a zero based column value instead of one
     based column value for editors that require it.

docs/src/markdown/extras.md

@@ -28,10 +28,9 @@
    appropriately. Also note that we quote `%1` to allow spaces in the command line argument. Paths may vary, and it is
    left up to the user to discover where their Python install directory is.
 
-    /// warning
-    This isn't a guide in how to do registry editing proper, so only edit the registry if you are certain of what you
-    are doing.
-    ///
+    > [!warning]
+    > This isn't a guide in how to do registry editing proper, so only edit the registry if you are certain of what you
+    > are doing.
 
     ```ini
     Windows Registry Editor Version 5.00

docs/src/markdown/preferences.md

@@ -33,17 +33,16 @@ Updates
     The check is only a check for new versions and doesn't perform an upgrade.  Rummage must be upgraded via `pip` from
     command line.
 
-    //// info | Update Issues: Python 3.6+ on macOS
-    There is a small issue on macOS with Python 3.6+: Python 3.6 changed how it gets the default certificates
-    required to properly check URLs. The details are actually documented here: https://bugs.python.org/issue28150#msg276516.
-
-    It is possible that a given installation method resolves this automatically, but if not, the following steps
-    should help. Assuming that Python 3.6+ was installed using the macOS installer from Python.org, you just need to
-    navigate to `/Applications/Python 3.6/Install Certificates.command` and double click the command.  The script
-    will use `pip` to install `certifi` and creates a symlink in the OpenSSL directory to `certifi`'s installed
-    bundle location. If you are using something like macports, then you'll probably have to research to find out how
-    to do the same thing.
-    ////
+    > [!info] Update Issues: Python 3.6+ on macOS
+    > There is a small issue on macOS with Python 3.6+: Python 3.6 changed how it gets the default certificates
+    > required to properly check URLs. The details are actually documented here: https://bugs.python.org/issue28150#msg276516.
+    >
+    > It is possible that a given installation method resolves this automatically, but if not, the following steps
+    > should help. Assuming that Python 3.6+ was installed using the macOS installer from Python.org, you just need to
+    > navigate to `/Applications/Python 3.6/Install Certificates.command` and double click the command.  The script
+    > will use `pip` to install `certifi` and creates a symlink in the OpenSSL directory to `certifi`'s installed
+    > bundle location. If you are using something like macports, then you'll probably have to research to find out how
+    > to do the same thing.
 
 International Time
 
@@ -121,9 +120,8 @@ Argument Variables | Description
 `{$col}`           | Insert the column number.
 `{$col0}`          | Insert the line column offset by one so the first column is zero instead of one.
 
-/// new | New 4.7.0
-Added `{$col0}` for zero based column values.
-///
+> [!new] New 4.7.0
+> Added `{$col0}` for zero based column values.
 
 ## Notifications
 
@@ -136,37 +134,34 @@ On Linux, you can set your preferred player: `paplay`, `aplay`, and `play` (`sox
 
 A test button is provided to test the configuration once set.
 
-/// tip | Supported Notification Sound Formats
-
-Windows | macOS                    | Linux
-------- | ------------------------ | -----
-`wav`   | `wav`, `mp3` and `.aiff` | `wav` and `mp3` (if using `paplay`, `ogg` is also supported)
-///
+> [!tip] Supported Notification Sound Formats
+>
+> Windows | macOS                    | Linux
+> ------- | ------------------------ | -----
+> `wav`   | `wav`, `mp3` and `.aiff` | `wav` and `mp3` (if using `paplay`, `ogg` is also supported)
 
 /// define
 Linux
 
 -   Native: Notifications via `notify-send`.
 
-    /// info | Other Distros
-    Though Rummage should run on any Linux distro, the native notification option was built around `notify-send` and
-    only tested on Ubuntu. If other distros have a `notify-send` it may also work.
-    ///
+    > [!info] Other Distros
+    > Though Rummage should run on any Linux distro, the native notification option was built around `notify-send` and
+    > only tested on Ubuntu. If other distros have a `notify-send` it may also work.
 
 macOS
 
 -   Native: Notification Center via [terminal-notifier][terminal-notifier]. Path to `terminal-notifier` must be
     configured.
 
-    /// info | Configuring macOS Native
-    When selecting `native` on macOS, an option to select the path to terminal notifier will be available since
-    native dialogs rely on `terminal-notifier` to send notifications to the Notification Center. This must be
-    configured or *native* notifications will not work.
-
-    When selecting the `terminal-notifier` path, you can select either the binary directly or the `.<app` bundle
-    (depending on how you installed `terminal-notifier`).  When selecting the `.app` bundle, Rummage will know how
-    to access the binary inside the bundle.
-    ///
+    > [!info] Configuring macOS Native
+    > When selecting `native` on macOS, an option to select the path to terminal notifier will be available since
+    > native dialogs rely on `terminal-notifier` to send notifications to the Notification Center. This must be
+    > configured or *native* notifications will not work.
+    >
+    > When selecting the `terminal-notifier` path, you can select either the binary directly or the `.<app` bundle
+    > (depending on how you installed `terminal-notifier`).  When selecting the `.app` bundle, Rummage will know how
+    > to access the binary inside the bundle.
 
 Windows
 

docs/src/markdown/search.md

@@ -54,14 +54,13 @@ Force\ <encoding> | Forces all files to be opened with the specified encod
 Use\ chain\ search      | Puts Rummage into ["search chain" mode](./usage.md#search-chains). When in "search chain" mode, rummage will only use saved search chains for search and replace.
 Use\ replace\ plugin    | When enabled, Rummage will use a [replace plugin](./usage.md#replace-plugins) instead of a replace pattern in order to do more advanced replaces.
 
-/// tip | Encoding Guessing
-
-It is always recommended, if you know the encoding, to use `Force encoding` as it will always be the fastest.
-Encoding guessing can be slow and not always accurate.
-
-Encoding guessing is performed by `chardet` which is a pure Python library and is, by far, the slowest option.  If
-you manually install `cChardet`, you will have a much faster guessing experience.
-///
+> [!tip] Encoding Guessing
+>
+> It is always recommended, if you know the encoding, to use `Force encoding` as it will always be the fastest.
+> Encoding guessing can be slow and not always accurate.
+>
+> Encoding guessing is performed by `chardet` which is a pure Python library and is, by far, the slowest option.  If
+> you manually install `cChardet`, you will have a much faster guessing experience.
 
 ## File Patterns
 
@@ -115,36 +114,35 @@ Pattern           | Meaning
 `\v`              |  ASCII Vertical Tab (VT).
 
 
-/// example | Example Patterns
-
-Used in the `Files which match` box, this would match all Python files of `.py` extensions excluding `__init__.py`:
-
-```
-*.py|-__init__.py
-```
-
-Used in the `Files which match` box, this would match any file type that is not `.py`.
-
-```
--*.py
-```
-
-Used in the `Exclude folders`, this would exclude all folders with `name` followed by a single digit, except `name3`
-which we will always be included.
-
-```
-name[0-9]|-name3
-```
-
-Used in the `Exclude folders`, this would exclude all folders except `name3`.
-
-```
--name3
-```
-
-If you need to escape `-` or `|`, you can put them in a sequence: `[-|]`. Remember to place `-` at the beginning of
-a sequence as `-` is also used to specify character ranges: `[a-z]`.
-///
+> [!example] Example Patterns
+>
+> Used in the `Files which match` box, this would match all Python files of `.py` extensions excluding `__init__.py`:
+>
+> ```
+> *.py|-__init__.py
+> ```
+>
+> Used in the `Files which match` box, this would match any file type that is not `.py`.
+>
+> ```
+> -*.py
+> ```
+>
+> Used in the `Exclude folders`, this would exclude all folders with `name` followed by a single digit, except `name3`
+> which we will always be included.
+>
+> ```
+> name[0-9]|-name3
+> ```
+>
+> Used in the `Exclude folders`, this would exclude all folders except `name3`.
+>
+> ```
+> -name3
+> ```
+>
+> If you need to escape `-` or `|`, you can put them in a sequence: `[-|]`. Remember to place `-` at the beginning of
+> a sequence as `-` is also used to specify character ranges: `[a-z]`.
 
 #### Extended Match Syntax
 
@@ -160,25 +158,23 @@ Pattern           | Meaning
 `!(pattern_list)` | The pattern matches if the input string cannot be matched with any of the patterns in the `pattern_list`. Requires extended match feature to be enabled.
 `{}`              | Bash style brace expansions.  This is applied to patterns before anything else. Requires brace expansion feature to be enabled.
 
-/// example | Example Extended Match Patterns
-For example, if we wanted to match files `this-file.txt` and `that-file.txt`, we could provide the following pattern:
-
-```
-@(this|that)-file.txt
-```
-
-The `|` contained within an extended match group will not split the pattern. So it is safe to combine with other patterns:
-
-```
-@(this|that)-file.txt|*.py
-```
-///
-
-/// tip | `!` and Extended Match Syntax
-If you have changed Rummage to use `!` instead of `-` for exclusion patterns and have enabled extended match
-patterns, you must escape `(` at the start of a file if you want the pattern to be recognized as an exclusion
-pattern instead of treating it as the start of an extended match pattern (`!(...)`).
-///
+> [!example] Example Extended Match Patterns
+> For example, if we wanted to match files `this-file.txt` and `that-file.txt`, we could provide the following pattern:
+>
+> ```
+> @(this|that)-file.txt
+> ```
+>
+> The `|` contained within an extended match group will not split the pattern. So it is safe to combine with other patterns:
+>
+> ```
+> @(this|that)-file.txt|*.py
+> ```
+
+> [!tip] `!` and Extended Match Syntax
+> If you have changed Rummage to use `!` instead of `-` for exclusion patterns and have enabled extended match
+> patterns, you must escape `(` at the start of a file if you want the pattern to be recognized as an exclusion
+> pattern instead of treating it as the start of an extended match pattern (`!(...)`).
 
 #### Brace Expansion Syntax
 
@@ -200,13 +196,12 @@ Pattern           | Meaning
 `{,}`             | Bash style brace expansions.  This is applied to patterns before anything else. Requires brace expansion feature to be enabled.
 `{n1..n2[..i]}`   | Bash style sequences that expands a range of numbers or alphabetic characters by an optional increment.
 
-/// example | Example Brace Expansion
--   `a{b,{c,d}}` --> `ab ac ad`
--   `{1..3}` --> `1 2 3`
--   `{a..d}` --> `a b c d`
--   `{2..4..2}` --> `2 4`
--   `{a..e..2}` --> `a c e`
-///
+> [!example] Example Brace Expansion
+> -   `a{b,{c,d}}` --> `ab ac ad`
+> -   `{1..3}` --> `1 2 3`
+> -   `{a..d}` --> `a b c d`
+> -   `{2..4..2}` --> `2 4`
+> -   `{a..e..2}` --> `a c e`
 
 #### Full Path Matching
 

docs/src/markdown/usage.md

@@ -87,14 +87,12 @@ You can also restrict which files get searched by providing wild card patterns (
 default, the patterns are applied to the base file or folder name. See [File Patterns](./search.md#wildcard) to learn
 more about accepted wild card pattern syntax and how to configure optional file pattern features.
 
-/// tip | Hidden Files
-Rummage assumes dot files as hidden on all systems. Additionally, on Windows and macOS, it will also look at a
-file's filesystem attributes to determine if the system is potentially hiding the file as well.
-///
+> [!tip] Hidden Files
+> Rummage assumes dot files as hidden on all systems. Additionally, on Windows and macOS, it will also look at a
+> file's filesystem attributes to determine if the system is potentially hiding the file as well.
 
-/// new | New 4.4.0
-Added symlink following via the **Follow symlinks** toggle.
-///
+> [!new] New 4.4.0
+> Added symlink following via the **Follow symlinks** toggle.
 
 ### Results
 
@@ -106,10 +104,9 @@ options.
 
 ![Content Tab](images/content_tab.png)
 
-/// tip | Column Options
-You can hide/show columns by right clicking the list header to get a special context menu. You can then deselect or
-select the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.
-///
+> [!tip] Column Options
+> You can hide/show columns by right clicking the list header to get a special context menu. You can then deselect or
+> select the column(s) you wish to hide/show respectively. You can also reorder the columns if desired.
 
 ## Regular Expression Tester
 
@@ -278,32 +275,31 @@ POSIX = 0x2000          # (?p)
 LITERAL = 0x10000           # Literal search
 ```
 
-/// example | Example Plugin
-In the example below, we have a replace plugin that replaces the search result with the name of the file.  It is
-assumed this is not a binary replace, so a Unicode string is returned.
-
-```py3
-from __future__ import unicode_literals
-from rummage.lib import rumcore
-import os
-
-
-class TestReplace(rumcore.ReplacePlugin):
-    """Replace object."""
-
-    def replace(self, m):
-        """Replace method."""
-
-        name = os.path.basename(self.get_file_name())
-        return name
-
-
-def get_replace():
-    """Get the replace object."""
-
-    return TestReplace
-```
-///
+> [!example] Example Plugin
+> In the example below, we have a replace plugin that replaces the search result with the name of the file.  It is
+> assumed this is not a binary replace, so a Unicode string is returned.
+>
+> ```py3
+> from __future__ import unicode_literals
+> from rummage.lib import rumcore
+> import os
+>
+>
+> class TestReplace(rumcore.ReplacePlugin):
+>     """Replace object."""
+>
+>     def replace(self, m):
+>         """Replace method."""
+>
+>         name = os.path.basename(self.get_file_name())
+>         return name
+>
+>
+> def get_replace():
+>     """Get the replace object."""
+>
+>     return TestReplace
+> ```
 
 ## Export to CSV or HTML
 
@@ -313,7 +309,6 @@ Rummage allows the exporting of the results to either CSV or HTML. Simply select
 **CSV** or **HTML**.  The HTML output will be styled similar to the GUI interface with the results in tables with
 sortable columns.
 
-/// info | Large Result Sets
-Really, really large sets of results will probably be best suited for CSV as a browser may have a hard time loading
-the entire data set at once.
-///
+> [!info] Large Result Sets
+> Really, really large sets of results will probably be best suited for CSV as a browser may have a hard time loading
+> the entire data set at once.