From 450e111e18fed8a91f2f5ccf1b07437925865366 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sun, 7 Jun 2020 16:54:30 +0200 Subject: [PATCH] disable spellchecker for 'highlight' shortcodes --- .dictionary | 9 ++------- docs/content/configuration/_index.md | 14 +++++++++++--- docs/content/setup/_index.md | 12 +++++++++--- docs/content/usage/_index.md | 2 ++ 4 files changed, 24 insertions(+), 13 deletions(-) diff --git a/.dictionary b/.dictionary index e36db98..1fb7eba 100644 --- a/.dictionary +++ b/.dictionary @@ -1,15 +1,10 @@ -([a-zA-Z0-9]+[_=])+\S+ -@\S+ -Autostop CLI Codecov Kaussow PyPI YAML -gc -sudo xoxys -toc -entrypoint SELinux dateparser +Autostop +entrypoint diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md index 858f800..09c1767 100644 --- a/docs/content/configuration/_index.md +++ b/docs/content/configuration/_index.md @@ -2,7 +2,9 @@ title: Configuration --- + {{< toc >}} + _docker-tidy_ comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs. @@ -18,6 +20,7 @@ Changes can be made on different locations which will be processed in the follow + {{< highlight YAML "linenos=table" >}} --- # don't do anything @@ -41,13 +44,15 @@ stop: max_run_time: prefix: [] {{< /highlight >}} - + + ## Environment Variables + {{< highlight Shell "linenos=table" >}} TIDY_CONFIG_FILE= TIDY_DRY_RUN=False @@ -65,7 +70,8 @@ TIDY_STOP_MAX_RUN_TIME= # comma-separated list TIDY_STOP_PREFIX= {{< /highlight >}} - + + ## CLI options @@ -74,6 +80,7 @@ You can get all available CLI options by running `docker-tidy --help`: + {{< highlight Shell "linenos=table" >}} $ docker-tidy --help usage: docker-tidy [-h] [--dry-run] [-t HTTP_TIMEOUT] [-v] [-q] [--version] @@ -95,5 +102,6 @@ optional arguments: -q decrease log level --version show program's version number and exit {{< /highlight >}} - + + diff --git a/docs/content/setup/_index.md b/docs/content/setup/_index.md index 67af862..b8354a8 100644 --- a/docs/content/setup/_index.md +++ b/docs/content/setup/_index.md @@ -2,12 +2,15 @@ title: Setup --- + {{< toc >}} + ## Pip + {{< highlight Shell "linenos=table" >}} # From PyPI as unprivileged user $ pip install docker-tidy --user @@ -18,7 +21,8 @@ $ sudo pip install docker-tidy # From Wheel file $ pip install https://github.com/xoxys/docker-tidy/releases/download/v0.1.0/docker_tidy-0.1.0-py2.py3-none-any.whl {{< /highlight >}} - + + ## Docker @@ -28,6 +32,7 @@ if you want to use other sub-commands like `stop`. + {{< highlight Shell "linenos=table" >}} docker run \ -e TIDY_GC_MAX_CONTAINER_AGE="3 days ago" \ @@ -35,7 +40,8 @@ docker run \ -v /var/run/docker.sock:/var/run/docker.sock \ xoxys/docker-tidy {{< /highlight >}} - + + @@ -44,5 +50,5 @@ docker run \ **Info**\ Keep in mind, that you have to pass SELinux labels (:Z or :z) to your mount option if you are working on SELinux enabled systems. {{< /hint >}} - + diff --git a/docs/content/usage/_index.md b/docs/content/usage/_index.md index 6f2c13d..d63e6e3 100644 --- a/docs/content/usage/_index.md +++ b/docs/content/usage/_index.md @@ -2,7 +2,9 @@ title: Usage --- + {{< toc >}} + ## Garbage Collector