From a5b3eab6033a56ac53b478e8b4a0a14e8ff7c152 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Wed, 3 Jun 2020 16:22:56 +0200 Subject: [PATCH] fix docs formatting --- .dictionary | 1 - .markdownlint.yml | 2 ++ docs/content/configuration/_index.md | 12 ++++++------ docs/content/configuration/cli.md | 4 +++- docs/content/configuration/defaults.md | 2 ++ docs/content/configuration/env.md | 2 ++ docs/content/setup/_index.md | 1 - docs/content/setup/docker.md | 3 ++- docs/content/setup/pip.md | 3 ++- docs/content/usage/_index.md | 18 ++++++++++-------- 10 files changed, 29 insertions(+), 19 deletions(-) diff --git a/.dictionary b/.dictionary index e7d132f..f23dd67 100644 --- a/.dictionary +++ b/.dictionary @@ -11,7 +11,6 @@ YAML Yaml ansible-.+ basename -cli config dir SELinux diff --git a/.markdownlint.yml b/.markdownlint.yml index 9927db2..b59a114 100644 --- a/.markdownlint.yml +++ b/.markdownlint.yml @@ -2,3 +2,5 @@ default: True MD013: False MD041: False +MD004: + style: dash diff --git a/docs/content/configuration/_index.md b/docs/content/configuration/_index.md index 109533a..45e873c 100644 --- a/docs/content/configuration/_index.md +++ b/docs/content/configuration/_index.md @@ -2,12 +2,12 @@ title: Configuration --- -*ansible-doctor* comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs. +_ansible-doctor_ comes with default settings which should be sufficient for most users to start, but you can adjust most settings to your needs. Changes can be made on different locations which will be processed in the following order (last wins): -* default config (build-in) -* global config file (path depends on your operating system) -* folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir) -* environment variables -* cli options +- default config (build-in) +- global config file (path depends on your operating system) +- folder-based config file (.ansibledoctor.yml|.ansibledoctor.yaml|.ansibledoctor in current working dir) +- environment variables +- CLI options diff --git a/docs/content/configuration/cli.md b/docs/content/configuration/cli.md index f7dc645..cabca2e 100644 --- a/docs/content/configuration/cli.md +++ b/docs/content/configuration/cli.md @@ -2,8 +2,9 @@ title: CLI options --- -You can get all available cli options by running `ansible-doctor --help`: +You can get all available CLI options by running `ansible-doctor --help`: + {{< highlight Shell "linenos=table" >}} $ ansible-doctor --help usage: ansible-doctor [-h] [-c CONFIG_FILE] [-o OUTPUT_DIR] [-f] [-d] [-v] @@ -27,3 +28,4 @@ optional arguments: -q decrease log level --version show program's version number and exit {{< /highlight >}} + diff --git a/docs/content/configuration/defaults.md b/docs/content/configuration/defaults.md index 7fd8314..200d188 100644 --- a/docs/content/configuration/defaults.md +++ b/docs/content/configuration/defaults.md @@ -2,6 +2,7 @@ title: Default settings --- + {{< highlight YAML "linenos=table" >}} --- @@ -38,3 +39,4 @@ exclude_files: [] # - files/**/*.py {{< /highlight >}} + diff --git a/docs/content/configuration/env.md b/docs/content/configuration/env.md index 0ba225c..05f7694 100644 --- a/docs/content/configuration/env.md +++ b/docs/content/configuration/env.md @@ -2,6 +2,7 @@ title: Environment Variables --- + {{< highlight Shell "linenos=table" >}} ANSIBLE_DOCTOR_CONFIG_FILE= ANSIBLE_DOCTOR_ROLE_DIR= @@ -17,3 +18,4 @@ ANSIBLE_DOCTOR_CUSTOM_HEADER= ANSIBLE_DOCTOR_EXCLUDE_FILES= ANSIBLE_DOCTOR_EXCLUDE_FILES=molecule/,files/**/*.py {{< /highlight >}} + diff --git a/docs/content/setup/_index.md b/docs/content/setup/_index.md index caddedb..0e51640 100644 --- a/docs/content/setup/_index.md +++ b/docs/content/setup/_index.md @@ -1,4 +1,3 @@ --- title: Setup - --- diff --git a/docs/content/setup/docker.md b/docs/content/setup/docker.md index 314d881..05d1622 100644 --- a/docs/content/setup/docker.md +++ b/docs/content/setup/docker.md @@ -1,8 +1,8 @@ --- title: Using docker - --- + {{< highlight Shell "linenos=table" >}} docker run \ -e ANSIBLE_DOCTOR_ROLE_DIR=example/demo-role/ \ @@ -15,6 +15,7 @@ docker run \ -w /doctor \ xoxys/ansible-doctor {{< /highlight >}} + {{< hint info >}} **Info**\ diff --git a/docs/content/setup/pip.md b/docs/content/setup/pip.md index ee681ad..0edbe71 100644 --- a/docs/content/setup/pip.md +++ b/docs/content/setup/pip.md @@ -1,8 +1,8 @@ --- title: Using pip - --- + {{< highlight Shell "linenos=table" >}} # From PyPI as unprivileged user @@ -15,3 +15,4 @@ $ sudo pip install ansible-doctor $ pip install https://github.com/xoxys/ansible-doctor/releases/download/v0.1.1/ansible_doctor-0.1.1-py2.py3-none-any.whl {{< /highlight >}} + diff --git a/docs/content/usage/_index.md b/docs/content/usage/_index.md index c72abb7..9eadd0f 100644 --- a/docs/content/usage/_index.md +++ b/docs/content/usage/_index.md @@ -6,15 +6,16 @@ title: Usage ansible-doctor FOLDER ``` -If you don't pass a folder to *ansible-doctor* your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a subfolder called `tasks` is MUST be an Ansible role! :) +If you don't pass a folder to _ansible-doctor_ your current working directory will be used. The first step is to identify if the given folder is an Ansible role. This check is very simple, if the folder contains a subfolder called `tasks` is MUST be an Ansible role! :) -After the successful check, *ansible-doctor* will try to read some static files into a dictionary: +After the successful check, _ansible-doctor_ will try to read some static files into a dictionary: -* defaults/main.yml -* meta/main.yml +- defaults/main.yml +- meta/main.yml This will be the base result set which is used as data source for every output template. Without any work, you will get at least a documentation about available variables and some meta information. Theses basic information can be expanded with a set of available annotations. In general, an annotation is a comment with an identifier. This identifier is followed by colon separated options and ends with a value. + {{< highlight Yaml "linenos=table" >}} # @identifier option1:option2: @@ -28,10 +29,11 @@ This will be the base result set which is used as data source for every output t docker_registry_password: "secret" {{< /highlight >}} + These list of predefined identifiers is currently available: -* @meta -* @todo -* @var -* @tag +- @meta +- @todo +- @var +- @tag