From 3ed2e75ac73b48e9ee443aac4336430230060999 Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Fri, 17 May 2024 19:45:45 +0000 Subject: [PATCH] . d updated markdown snippets & formatting --- docs/how_tos/ConfigureReportersWithOptions.md | 2 +- docs/how_tos/TestCombinationOfParameters.md | 2 +- readme.md | 73 +++++++++---------- 3 files changed, 36 insertions(+), 41 deletions(-) diff --git a/docs/how_tos/ConfigureReportersWithOptions.md b/docs/how_tos/ConfigureReportersWithOptions.md index a0d634c6..9a746b26 100644 --- a/docs/how_tos/ConfigureReportersWithOptions.md +++ b/docs/how_tos/ConfigureReportersWithOptions.md @@ -35,7 +35,7 @@ options = options.withConfig(configModifier); verify("Hello", options); ``` -snippet source | anchor +snippet source | anchor diff --git a/docs/how_tos/TestCombinationOfParameters.md b/docs/how_tos/TestCombinationOfParameters.md index 49d09c28..2f5fa51e 100644 --- a/docs/how_tos/TestCombinationOfParameters.md +++ b/docs/how_tos/TestCombinationOfParameters.md @@ -47,7 +47,7 @@ test("CombinationsStartingPoint", () => { }); ``` -snippet source | anchor +snippet source | anchor diff --git a/readme.md b/readme.md index d8831e93..412a30f8 100644 --- a/readme.md +++ b/readme.md @@ -1,43 +1,42 @@ # Approvals (Approval Tests for Node.js) - ## Contents -- [Intro](#intro) -- [Badges](#badges) -- [Integrations](#integrations) -- [Getting Started](#getting-started) - - [Jest Typescript Starter Project](#jest-typescript-starter-project) - - [Mocha](#mocha) -- [Documentation](#documentation) -- [CLI](#cli) - - [Install Approvals CLI](#install-approvals-cli) - - [CLI Help](#cli-help) -- [Simple hello world](#simple-hello-world) -- [Specify diff reporter (great for C.I.)](#specify-diff-reporter-great-for-ci) -- [Multiple diff reporters](#multiple-diff-reporters) -- [Reporters](#reporters) - - [Built-In Reporters](#built-in-reporters) -- [Supported Diff Tools](#supported-diff-tools) - - [Custom Reporter](#custom-reporter) -- [Configuration](#configuration) -- [API](#api) -- [approvals](#approvals) - - [approvals.configure](#approvalsconfigure) - - [approvals.getConfig ⇒ Object](#approvalsgetconfig--codeobjectcode) - - [approvals.verify](#approvalsverify) - - [approvals.verifyAndScrub](#approvalsverifyandscrub) - - [approvals.verifyAsJSON](#approvalsverifyasjson) - - [approvals.verifyAsJSONAndScrub](#approvalsverifyasjsonandscrub) - - [approvals.verifyWithControl](#approvalsverifywithcontrol) - - [approvals.mocha](#approvalsmocha) - - [approvals.reporters](#approvalsreporters) - - [approvals.scrubbers](#approvalsscrubbers) -- [Source Control](#source-control) - - [Git](#git) -- [Contributing](#contributing) -- [License](#license) + * [Intro](#intro) + * [Badges](#badges) + * [Integrations](#integrations) + * [Getting Started](#getting-started) + * [Jest Typescript Starter Project](#jest-typescript-starter-project) + * [Mocha](#mocha) + * [Documentation](#documentation) + * [CLI](#cli) + * [Install Approvals CLI](#install-approvals-cli) + * [CLI Help](#cli-help) + * [Simple hello world](#simple-hello-world) + * [Specify diff reporter (great for C.I.)](#specify-diff-reporter-great-for-ci) + * [Multiple diff reporters](#multiple-diff-reporters) + * [Reporters](#reporters) + * [Built-In Reporters](#built-in-reporters) + * [Supported Diff Tools](#supported-diff-tools) + * [Custom Reporter](#custom-reporter) + * [Configuration](#configuration) + * [API](#api) + * [approvals](#approvals) + * [approvals.configure](#approvalsconfigure) + * [approvals.getConfig ⇒ Object](#approvalsgetconfig--codeobjectcode) + * [approvals.verify](#approvalsverify) + * [approvals.verifyAndScrub](#approvalsverifyandscrub) + * [approvals.verifyAsJSON](#approvalsverifyasjson) + * [approvals.verifyAsJSONAndScrub](#approvalsverifyasjsonandscrub) + * [approvals.verifyWithControl](#approvalsverifywithcontrol) + * [approvals.mocha](#approvalsmocha) + * [approvals.reporters](#approvalsreporters) + * [approvals.scrubbers](#approvalsscrubbers) + * [Source Control](#source-control) + * [Git](#git) + * [Contributing](#contributing) + * [License](#license) @@ -286,9 +285,7 @@ it("should use a multiple reporters", function () { ``` - - ```ts export const defaultConfig: Config = { reporters: [ @@ -312,9 +309,7 @@ export const defaultConfig: Config = { maxLaunches: 10, }; ``` - snippet source | anchor -