Documentation updates (#252)

Resolves #234

Author: facelessuser

docs/src/markdown/about/contributing.md

@@ -9,11 +9,11 @@ ST4               | Fully supports the early development releases.
 
 Contribution from the community is encouraged and can be done in a variety of ways:
 
-- Become a sponsor.
-- Bug reports.
-- Reviewing code.
-- Code patches via pull requests.
-- Documentation improvements via pull requests.
+-   Become a sponsor.
+-   Bug reports.
+-   Reviewing code.
+-   Code patches via pull requests.
+-   Documentation improvements via pull requests.
 
 ## Become a Sponsor :octicons-heart-fill-16:{: .heart-throb}
 
@@ -25,26 +25,26 @@ any tier you feel comfortable with. No amount is too little. We also accept one
 
 ## Bug Reports
 
-1. Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
-   **before** posting an issue.
+1.  Please **read the documentation** and **search the issue tracker** to try to find the answer to your question
+    **before** posting an issue.
 
-2. When an issue is created, a [template][template] will be shown, please fill out the appropriate sections. If the
-   template is not followed, the issue will be marked `Invalid` and closed.
+2.  When an issue is created, a [template][template] will be shown, please fill out the appropriate sections. If the
+    template is not followed, the issue will be marked `Invalid` and closed.
 
-3. When creating an issue on the repository, please provide as much info as possible:
+3.  When creating an issue on the repository, please provide as much info as possible:
 
-    - Provide environment information by running `Preferences->Package Settings->ColorHelper->Support Info`.  The
-      information will be copied to the clipboard; paste the info in issue.
-    - Errors in console.
-    - Detailed description of the problem.
-    - Examples for reproducing the error.  You can post pictures, but if specific text or code is required to reproduce
-      the issue, please provide the text in a plain text format for easy copy/paste.
-    - Provide links to 3rd party syntax highlighting package you are using if applicable.
+    -   Provide environment information by running `Preferences->Package Settings->ColorHelper->Support Info`.  The
+        information will be copied to the clipboard; paste the info in issue.
+    -   Errors in console.
+    -   Detailed description of the problem.
+    -   Examples for reproducing the error.  You can post pictures, but if specific text or code is required to
+        reproduce the issue, please provide the text in a plain text format for easy copy/paste.
+    -   Provide links to 3rd party syntax highlighting package you are using if applicable.
 
     The more info provided, the greater the chance someone will take the time to answer, implement, or fix the issue.
 
-4. Be prepared to answer questions and provide additional information if required.  Issues in which the creator refuses
-   to respond to follow up questions will be marked as stale and closed.
+4.  Be prepared to answer questions and provide additional information if required.  Issues in which the creator refuses
+    to respond to follow up questions will be marked as stale and closed.
 
 ## Reviewing Code
 
@@ -56,17 +56,17 @@ solutions to overcome weakness in the algorithm.
 Pull requests are welcome, and if you plan on contributing directly to the code, there are a couple of things to be
 mindful of.
 
-1. Please describe the change in as much detail as possible so I can understand what is being added or modified.
+1.  Please describe the change in as much detail as possible so I can understand what is being added or modified.
 
-2. If you are solving a bug that does not already have an issue, please describe the bug in detail and provide info on
-   how to reproduce if applicable (this is good for me and others to reference later when verifying the issue has been
-   resolved).
+2.  If you are solving a bug that does not already have an issue, please describe the bug in detail and provide info on
+    how to reproduce if applicable (this is good for me and others to reference later when verifying the issue has been
+    resolved).
 
-3. Please reference and link related open bugs or feature requests in this pull if applicable.
+3.  Please reference and link related open bugs or feature requests in this pull if applicable.
 
-4. Make sure you've documented or updated the existing documentation if introducing a new feature or modifying the
-   behavior of an existing feature that a user needs to be aware of.  I will not accept new features or changes to
-   existing features if you have not provided documentation describing the feature.
+4.  Make sure you've documented or updated the existing documentation if introducing a new feature or modifying the
+    behavior of an existing feature that a user needs to be aware of.  I will not accept new features or changes to
+    existing features if you have not provided documentation describing the feature.
 
 Continuous integration tests on are run on all pull requests and commits via Travis CI.  When making a pull request, the
 tests will automatically be run, and the request must pass to be accepted.  You can (and should) run these tests before
@@ -75,20 +75,21 @@ it is strongly suggested that requesters make an effort to verify before request
 
 ### Running Validation Tests
 
-!!! tip "Tip"
-    If you are running Sublime on a Mac OS or Linux/Unix system, you run all tests by by running the shell script
-    (assuming you have installed your environment fulfills all requirements below):
+/// tip | Tip
+If you are running Sublime on a Mac OS or Linux/Unix system, you run all tests by by running the shell script
+(assuming you have installed your environment fulfills all requirements below):
 
-    ```
-    chmod +x run_tests.sh
-    ./run_tests.sh
-    ```
+```
+chmod +x run_tests.sh
+./run_tests.sh
+```
+///
 
 There are a couple of dependencies that must be present before running the tests.
 
-1. As ST3 is the only current, actively supported version, Python 3.3 must be used to validate the tests.
+1.  As ST3 is the only current, actively supported version, Python 3.3 must be used to validate the tests.
 
-2. Unit tests are run with `pytest`.  You can install `pytest` via:
+2.  Unit tests are run with `pytest`.  You can install `pytest` via:
 
     ```
     pip install pytest
@@ -100,8 +101,8 @@ There are a couple of dependencies that must be present before running the tests
     py.test .
     ```
 
-3. Linting is performed on the entire project with `flake8`, `flake8-docstrings`, and `pep8-naming`.  These can be
-   installed via:
+3.  Linting is performed on the entire project with `flake8`, `flake8-docstrings`, and `pep8-naming`.  These can be
+    installed via:
 
     ```
     pip install flake8

docs/src/markdown/faq.md

@@ -9,6 +9,7 @@ Often, the duplicate colors may have a slightly different style, and when you cl
 ColorHelper dialog.
 
 ### LSP
+
 Two such examples are [`LSP-css`](https://packagecontrol.io/packages/LSP-css) and
 [`LSP-json`](https://packagecontrol.io/packages/LSP-json).
 

docs/src/markdown/index.md

@@ -10,12 +10,12 @@ in color palettes.  It even provides tools for calculating color contrast, inter
 
 ## Features
 
-- Inline color previews.
-- Useful tooltip popups that show the previews of selected colors.
-- Support colors in CSS, SCSS, SASS, HTML attributes, and more.
-- Allow saving, accessing, and managing colors in named color palettes all from the tooltip.
-- Select and insert colors from the color palettes via the tooltip.
-- Convert between color spaces. Supports `rgb`, `hsl`, `hwb`, `lch`, `lab`, and more!
-- Color picker, color interpolating, and color contrast tool.
+-   Inline color previews.
+-   Useful tooltip popups that show the previews of selected colors.
+-   Support colors in CSS, SCSS, SASS, HTML attributes, and more.
+-   Allow saving, accessing, and managing colors in named color palettes all from the tooltip.
+-   Select and insert colors from the color palettes via the tooltip.
+-   Convert between color spaces. Supports `rgb`, `hsl`, `hwb`, `lch`, `lab`, and more!
+-   Color picker, color interpolating, and color contrast tool.
 
 --8<-- "refs.md"

docs/src/markdown/installation.md

@@ -7,45 +7,46 @@ install the correct branch on your system and keep it up to date.
 
 ---
 
-1. Ensure Package Control is installed.  Instructions are found [here](https://packagecontrol.io/installation).
+1.  Ensure Package Control is installed.  Instructions are found [here](https://packagecontrol.io/installation).
 
-2. In Sublime Text, press <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>p</kbd> (Win, Linux) or <kbd>cmd</kbd> +
-<kbd>shift</kbd> + <kbd>p</kbd> (Mac OS) to bring up the quick panel and start typing
-`Package Control: Install Package`.  Select the command and it will show a list of installable plugins.
+2.  In Sublime Text, press <kbd>ctrl</kbd> + <kbd>shift</kbd> + <kbd>p</kbd> (Win, Linux) or <kbd>cmd</kbd> +
+    <kbd>shift</kbd> + <kbd>p</kbd> (Mac OS) to bring up the quick panel and start typing
+    `Package Control: Install Package`.  Select the command and it will show a list of installable plugins.
 
-3. Start typing `ColorHelper`; when you see it, select it.
+3.  Start typing `ColorHelper`; when you see it, select it.
 
-4. Restart to be sure everything is loaded proper.
+4.  Restart to be sure everything is loaded proper.
 
-5. Enjoy!
+5.  Enjoy!
 
 ## Manual Installation
 
-!!! warning "Warning"
-    This is not the recommended way to install ColorHelper for the average user.  Installing this way **will not** get
-    automatically updated.
+/// warning | Warning
+This is not the recommended way to install ColorHelper for the average user.  Installing this way **will not** get
+automatically updated.
 
-    If you are forking for a pull request, you should **just** clone ColorHelper and run Package Control's
-    `Satisfy Dependency` command to get all the dependencies.
+If you are forking for a pull request, you should **just** clone ColorHelper and run Package Control's
+`Satisfy Dependency` command to get all the dependencies.
+///
 
 For those who want to install ColorHelper without package control, here are the steps.  It understood that some people
 for what ever reason will prefer manually and may even have legitimate reasons to do so.  When going this route, you
 will have to keep all the packages updated yourself.
 
 ---
 
-1. Download the latest releases of the following dependencies and unpack or git clone in the `Packages` folder as shown
-   below:
+1.  Download the latest releases of the following dependencies and unpack or git clone in the `Packages` folder as shown
+    below:
 
-    - https://github.com/facelessuser/sublime-markdown-popups -> `mdpopups`
-    - https://github.com/packagecontrol/typing/issues -> `typing`
+    -   https://github.com/facelessuser/sublime-markdown-popups -> `mdpopups`
+    -   https://github.com/packagecontrol/typing/issues -> `typing`
 
-2. Download and unpack or git clone the latest ColorHelper release and unpack as `ColorHelper`:
+2.  Download and unpack or git clone the latest ColorHelper release and unpack as `ColorHelper`:
 
-    - https://github.com/facelessuser/ColorHelper -> ColorHelper
+    -   https://github.com/facelessuser/ColorHelper -> ColorHelper
 
-3. Create a folder under `Packages` called `00-dependencies` and under that folder create a file called
-   `00-dependencies.py`:
+3.  Create a folder under `Packages` called `00-dependencies` and under that folder create a file called
+    `00-dependencies.py`:
 
     Copy the following code to `00-dependencies.py` (this code was taken from Package Control):
 
@@ -201,20 +202,20 @@ will have to keep all the packages updated yourself.
     add_dependency('typing')
     ```
 
-4. Restart and enjoy.
+4.  Restart and enjoy.
 
 ## Git Cloning
 
-1. Quit Sublime Text.
+1.  Quit Sublime Text.
 
-2. Open a terminal and enter the following.  For dependencies replace the URL with the appropriate URL, and the
-   appropriate folder to check it out to:
+2.  Open a terminal and enter the following.  For dependencies replace the URL with the appropriate URL, and the
+    appropriate folder to check it out to:
 
     ```
     cd /path/to/Sublime Text 3/Packages
     git clone https://github.com/facelessuser/ColorHelper.git ColorHelper
     ```
 
-3. Restart Sublime Text.
+3.  Restart Sublime Text.
 
 --8<-- "refs.md"

docs/src/markdown/settings/previews.md

@@ -55,9 +55,11 @@ Controls whether previews will attempt to gamut map a color that is out of the p
 
 ## `gamut_space`
 
-!!! warning "Experimental Feature"
+/// warning | Experimental Feature
+///
 
-!!! new "New in 3.8.0"
+/// new | New in 3.8.0
+///
 
 Select the gamut space used for color previews. You should only pick a space that matches your system. If you happen
 to have a display that does not align with one of the spaces below, you may just have to pick whatever is closest.
@@ -78,7 +80,8 @@ for sRGB, then you should not touch the below setting.
 
 ## `gamut_map`
 
-!!! new "New in 6.2.0"
+/// new | New in 6.2.0
+///
 
 Select the gamut mapping approach used when displaying previews or when cohering colors into a specific gamut anywhere
 else in the code.

docs/src/markdown/settings/rules.md

@@ -78,9 +78,10 @@ A rule will define what kind of colors ColorHelper should look for, and where in
 `color_rules` is a list of rule sets, where each rule is a dictionary of options. Only one rule set can apply to a
 given view at a time.
 
-!!! tip
-    New rules and rule overrides should be added to [`user_color_rules`](#user_color_rules) instead of modifying
-    `color_rules` directly.
+/// tip
+New rules and rule overrides should be added to [`user_color_rules`](#user_color_rules) instead of modifying
+`color_rules` directly.
+///
 
 ### `name`
 
@@ -144,9 +145,9 @@ defined in [`color_classes`](#color_classes).
 If needed, you can define multiple color classes with a list of dictionaries. Each dictionary in the list should
 contain a `class` and `scopes`:
 
-- `scopes`: A string that defines a base scope that the color class applies to.
+-   `scopes`: A string that defines a base scope that the color class applies to.
 
-- `class`:  The name of the color class profile to use (defined in [`color_classes`](#color_classes)).
+-   `class`:  The name of the color class profile to use (defined in [`color_classes`](#color_classes)).
 
 ```js
     "color_class": [
@@ -283,26 +284,26 @@ The value should be the full import path for the `Color` class.
 If none of the provided color classes are sufficient, it is possible to create your own custom class. With that said,
 there are a few things to note:
 
-- Custom classes should be derived from the default base class, but there is a catch, ColorHelper handles the default
-  (`ColorHelper.lib.coloraide.Color`) special. This allows us to enable the users with the ability of defining what
-  color spaces the default class contains via the [`add_to_default_spaces`](#add_to_default_spaces) setting. In turn,
-  ensures all color spaces properly function in features like palettes, etc.
+-   Custom classes should be derived from the default base class, but there is a catch, ColorHelper handles the default
+    (`ColorHelper.lib.coloraide.Color`) special. This allows us to enable the users with the ability of defining what
+    color spaces the default class contains via the [`add_to_default_spaces`](#add_to_default_spaces) setting. In turn,
+    ensures all color spaces properly function in features like palettes, etc.
 
     So, if creating a custom color space, the user should call `ColorHelper.ch_util.get_base_color()` to get the actual
-  default class to derive from. Users should **not** derive directly from `ColorHelper.lib.coloraide.Color`.
+    default class to derive from. Users should **not** derive directly from `ColorHelper.lib.coloraide.Color`.
 
-- Colors are passed back and forth between custom color classes and the default color class. As long as both classes
-  know how to handle the color space, things should work without issue.
+-   Colors are passed back and forth between custom color classes and the default color class. As long as both classes
+    know how to handle the color space, things should work without issue.
 
     If a custom color class is using a color space that is not registered under the default class or is using a color
-  space derived from an unregistered color space, some features won't work.
+    space derived from an unregistered color space, some features won't work.
 
     In short, it is import to ensure that all color spaces that are actively used in custom color classes are
-  registered via [`add_to_default_spaces`](#add_to_default_spaces).
+    registered via [`add_to_default_spaces`](#add_to_default_spaces).
 
     If you are creating a brand new color space, you must also register it, or a version of that color space, with the
-  default color class. The registered color space must support the `color(id ...)` input and output format as that
-  format is often used when passing a color around internally within ColorAide.
+    default color class. The registered color space must support the `color(id ...)` input and output format as that
+    format is often used when passing a color around internally within ColorAide.
 
 ### `filters`