From 86f96460eef0cf2622d41b7d795e59acdee09014 Mon Sep 17 00:00:00 2001 From: kjuulh Date: Wed, 2 Aug 2023 14:16:23 +0200 Subject: [PATCH] docs: fix admonitions Signed-off-by: kjuulh --- docs/getting-started.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index de48ac6..68e23e0 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -20,7 +20,8 @@ or docker (not public yet) docker run -v $PWD:/mnt/src -e CUDDLE_PLEASE_TOKEN= kjuulh/cuddle-please:latest ``` -!!! warning Other distributions to be added. +!!! warning + Other distributions to be added. ## Configuration @@ -58,9 +59,12 @@ The token needs to have write access to your repository, as well as the api. Dry-run is used here to not commit any changes to your backend, it may still change your local git setup, but not the backends. Simply remove the arg if you -want to commit. !!! note `--token` can also be set with -`export CUDDLE_PLEASE_TOKEN=''` if you don't want to leak -the secret to your cli history. +want to commit. + +!!! note + `--token` can also be set with + + `export CUDDLE_PLEASE_TOKEN=''` if you don't want to leak the secret to your cli history. When run you should get output that it has created a dry_run pull-request, meaning that it was supposed to do the action but didn't commit it.