Browse Source

disable spellchecker for 'highlight' shortcodes

pull/2/head
Robert Kaussow 2 years ago
parent
commit
450e111e18
Signed by: xoxys
GPG Key ID: 65362AE74AF98B61
  1. 9
      .dictionary
  2. 14
      docs/content/configuration/_index.md
  3. 12
      docs/content/setup/_index.md
  4. 2
      docs/content/usage/_index.md

9
.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

14
docs/content/configuration/_index.md

@ -2,7 +2,9 @@
title: Configuration
---
<!-- spellchecker-disable -->
{{< toc >}}
<!-- spellchecker-enable -->
_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
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< highlight YAML "linenos=table" >}}
---
# don't do anything
@ -41,13 +44,15 @@ stop:
max_run_time:
prefix: []
{{< /highlight >}}
<!-- markdownlint-enable -->
<!-- spellchecker-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
## Environment Variables
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< 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 >}}
<!-- markdownlint-enable -->
<!-- spellchecker-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
## CLI options
@ -74,6 +80,7 @@ You can get all available CLI options by running `docker-tidy --help`:
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< 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 >}}
<!-- markdownlint-enable -->
<!-- spellchecker-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

12
docs/content/setup/_index.md

@ -2,12 +2,15 @@
title: Setup
---
<!-- spellchecker-disable -->
{{< toc >}}
<!-- spellchecker-enable -->
## Pip
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< 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 >}}
<!-- markdownlint-enable -->
<!-- spellchecker-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
## Docker
@ -28,6 +32,7 @@ if you want to use other sub-commands like `stop`.
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< 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 >}}
<!-- markdownlint-enable -->
<!-- spellchecker-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- prettier-ignore-start -->
@ -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 >}}
<!-- markdownlint-enable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

2
docs/content/usage/_index.md

@ -2,7 +2,9 @@
title: Usage
---
<!-- spellchecker-disable -->
{{< toc >}}
<!-- spellchecker-enable -->
## Garbage Collector

Loading…
Cancel
Save