From 707ad1fddb9043a76a6f883a3a8716784491d094 Mon Sep 17 00:00:00 2001 From: Kanad Gupta <8854718+kanadgupta@users.noreply.github.com> Date: Wed, 20 Dec 2023 14:34:33 -0600 Subject: [PATCH] docs: fix formatting (#952) --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bfb7a2385..c5e452926 100644 --- a/README.md +++ b/README.md @@ -186,7 +186,9 @@ This command also has a dry run mode, which can be useful for initial setup and If you run `rdme` within a directory that contains your OpenAPI or Swagger definition, you can omit the file path. `rdme` will then look for JSON or YAML files (including in sub-directories) that contain a top-level [`openapi`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#fixed-fields) or [`swagger`](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#fixed-fields) property. -> [!NOTE] `rdme` will not scan anything in the following: +> [!NOTE] +> +> `rdme` will not scan anything in the following: > > - Any `.git/` directories (if they exist) > - Any files/directories specified in `.gitignore` files (including any `.gitignore` files in subdirectories, if they exist)