Skip to content

Commit

Permalink
. d updated markdown snippets & formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed May 17, 2024
1 parent 9f93a56 commit 3ed2e75
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 41 deletions.
2 changes: 1 addition & 1 deletion docs/how_tos/ConfigureReportersWithOptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ options = options.withConfig(configModifier);
verify("Hello", options);
```

<sup><a href='/test/Providers/Jest/JestReporter.test.ts#L10-L22' title='Snippet source file'>snippet source</a> | <a href='#snippet-configure-reporter-with-options' title='Start of snippet'>anchor</a></sup>
<sup><a href='/test/Providers/Jest/JestReporter.test.ts#L9-L18' title='Snippet source file'>snippet source</a> | <a href='#snippet-configure-reporter-with-options' title='Start of snippet'>anchor</a></sup>

<!-- endSnippet -->

Expand Down
2 changes: 1 addition & 1 deletion docs/how_tos/TestCombinationOfParameters.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ test("CombinationsStartingPoint", () => {
});
```

<sup><a href='/test/Providers/Jest/CombinationApprovals.test.ts#L55-L61' title='Snippet source file'>snippet source</a> | <a href='#snippet-CombinationsStartingPoint' title='Start of snippet'>anchor</a></sup>
<sup><a href='/test/Providers/Jest/CombinationApprovals.test.ts#L107-L117' title='Snippet source file'>snippet source</a> | <a href='#snippet-CombinationsStartingPoint' title='Start of snippet'>anchor</a></sup>

<!-- endSnippet -->

Expand Down
73 changes: 34 additions & 39 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,42 @@
# Approvals (Approval Tests for Node.js)

<!-- toc -->

## 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 ⇒ <code>Object</code>](#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)<!-- endToc -->
* [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 ⇒ <code>Object</code>](#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)<!-- endToc -->

<a name="intro" />

Expand Down Expand Up @@ -286,9 +285,7 @@ it("should use a multiple reporters", function () {
```
<!-- snippet: default_config -->
<a id='snippet-default_config'></a>
```ts
export const defaultConfig: Config = {
reporters: [
Expand All @@ -312,9 +309,7 @@ export const defaultConfig: Config = {
maxLaunches: 10,
};
```
<sup><a href='/lib/config.ts#L22-L44' title='Snippet source file'>snippet source</a> | <a href='#snippet-default_config' title='Start of snippet'>anchor</a></sup>
<!-- endSnippet -->
<a name="api" />
Expand Down

0 comments on commit 3ed2e75

Please sign in to comment.