Skip to content

Commit 7d152da

Browse files
committed
docs: overhaul readme
The main README has been completely overhauled: - It is now more closely aligned with Pact JS and Pact Go - It is much shorter, with usage documentation having been moved into `/docs` - Reference to Pact Python `v3` has been added. Signed-off-by: JP-Ellis <josh@jpellis.me>
1 parent da18e10 commit 7d152da

File tree

5 files changed

+647
-520
lines changed

5 files changed

+647
-520
lines changed

.markdownlint.yml

+11-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
11
default: true
2+
3+
# Do not enforce line length
4+
line-length: false
5+
6+
# Adjust list indentation for 4 spaces
27
list-marker-space:
38
ul_single: 3
49
ul_multi: 3
510
ol_single: 2
611
ol_multi: 2
7-
line-length: false
812
ul-indent:
913
indent: 4
14+
15+
# Require fenced code blocks
1016
code-block-style:
1117
style: fenced
18+
19+
# Disable checking for reference links, as MkDocs generates additional ones that
20+
# are not visible to MarkdownLint.
21+
reference-links-images: false

0 commit comments

Comments
 (0)