QHk;;?^$rP^v{{!r-{$8*U3O}u(`)VqTi8BPYhSKpfyouBC+erj6Lb1s
z8<&3e-K7Tq&d%Jg^~LpW;#|0k$fc5dr8}Y+%m17DC@N9?Kb9GWroPPmD0g-?Adg2i
z(w9rwZ|^`dcCP{JtY)|#q1Kvy&V0MGv;$9};hZZF9l*5BNz(i=+G;bv*HE(XZBo3s
z;%#kh2_+D}0{lj{XC3XTKhr0hm44R}i%`8m8P4hcb)7;HRCa*VqJ`Vu?pG3BiTdsJ
z!RobgzP>J~xqG*OdG{hE+rzP)6f>r)TNDmjc2N_1zHbE&%WkPakjiH)o%bv+C4Z-;
z+`!X1O!CtbBccYUc-I&Bp~>=Gav=huh$c(vM{rEY174t9pG^CQ0>$%d%jqqqe1=^i
zre^~w%;Q%4zK`z`>1MP%?tL6qHmzZlY>|=S5C$nV)>{GTRu!JvR5+g`;a%gB#zDka
z53Z@w4Hm^8WGI&$ST*;&fX1-)_T!7a3KaQy4N~){RM9+(l;
zd)c`d@nC+V67nqa#f@vcAW~GvlQ0dDWjrY7#$nN+yiHWK@CIV&rL)K}rr;P!pf03H
zDgTJ{djUFjSC;YNr2jqAA3mJGa>YW!&ipp0`;adt@KoT(sL%egcC^d+Sv~7yAPu)8
zOSEdV6xG^nO|q)1gi(e^P$f$JLrr&yH8Z1Wmp1X%RY&^Nt^voNg6chCCp4(ga8(vG
zc+U~rrq$;T$*WeamNpWywdG!tQoGAuS{%a`u4V4P^E)4!|K%0h=MEdauYZUl=MW<~
z^HxlF$-;IjO*P!-&BD1P+z0I?tRZT(8)4cz6T5
zThaR*TQ}53`P-6yyqhdq3{l!be{pL+_F62-uCP>H%L}+A7_t8f*xvk}35|T!rYR)W
zD6b5aVTqMUeG#9+EDqcDi#TW&$Q-;jxEfhQl4*Szex>l6!!<7^11WCsFBUJJMb4UNyc{+AdV*K&zO%{8@B}IK8toX2HV_{U54z`*k*R_3iGR-6*=P{hc
z7cy)HCbeGcq)%U)S-MfB7+~=^NGYV8|LGwKUjvg!cUXVx_W_5-0N*2
zX#{HwUAo}gHT-v?q0rC9SGgnAf2f8p6%yTs)lQ*ju2F)^^4J1hEVgEngLj#7uo0aQ
z$SFbRwf6uv*tzy3T^I6YF4wSBhH(*_r`x`>uMWo5ICSg(FC|{aM&gjJ67D>r<8j9+KNl-S}_q9
z86@YC#N&k>EJN9MI*Z2M%-&7ujsiMWj-HwbBGxD|RUUV82Do)#OdaDTGcj}fpmc9$
zpT*eg4qsZq&f_a|G5r(j^Q)|{CY2<|EJ-gitajPYV5mqdk+d^wwhv#VqV&tsuVp
zSd#WTKUp42-qwX{bbg&c+kBf?j8KXlH=$6qS{e9&S3Rc;>PU`Z
z=#BZlTVHFqOd;i3z$!Oy?O023SzK!e(9nXbo%-ZMk3;eKk{@I%g(vTRm~bmGOl~dP
zC!d$AjTTvy!V5dDgqbcG?l-F+6lHwqdjk~B9{n2E2kKU7HD~%yV+7^$P2($DcW1MM
zo^4qU*!I|cQf*(kV`XN)QSzGXUFnT}IN1(=F)-Anf*r25H?)#0lp*IoDh7wf%
ztPTNj_`vI*jipZ`-`+K?frh8yEo<`D45z{*(!`)2o@tynxvsQJbsbrvi~H}IZ=l=c
zJOvwdq_yR|Y)YHn&$GUQp{Fm@E$W5NXk17e3L=|bFl6niqk_q3M^WY1OxS*{DsYu2
zP~Fd8qwjWD3)9Q2T1fg`E_D6gnN$2)zzlOx^|w3_M>5uVXyaCYn5SU_v_Ors&rEYx
z!MIKJm}TfB@1S8kHq{H|30Hi$^E7ov5v~Z^qrxnrbj%7^1cZB9O^A<|3~nfjJ^iBm!c#n{Jnu|J9#e)l1EeAvUnpNLXq
zKn|WRl4M`mb|Mahs5jCe
zVuL!evaiZNHJuaq3ChAE{gHt(od}|7_Mp<4o5;v%=5Mp0nV2!^KvDGhF<5aVS6(ti
zQOk%sVY&4DX^5wyWR+x=un7e`WHvQ)9oA3Q7m@Lgt;cKnKs17#=OyPC$=RY#rZ2i$
ze(}mLkryPCvSgN7J0?O>I-yH-q$i2P$PD@v
zV{ynIkKu}NWjQwimZ5MHMS)ZC3ex2sUqnJ84F{Z*hBfQiP~BR^P_sDQmWtqL;
z)q$1h)A*zo@kik!@ha5jZ7zn@mSe6aH7Xup-v!Y6nT-r@9|X~JS2dryH=BOoa{0IF
zgpb5PZ0gU5$XumpPfi*>aC%)Gb!}RM;r3MH@Xg?I>S^7|R1+kxwz^IrbBM8}`G|}^
zXp)5go`E*AXu7v?wx7=@{sA~#F2niI*`)^~q7o_aQ?DxJ*Ey2$K>7I>Z$k+u3iEmX
zet11UTD%MYjixtGFCi1cx|)`zJQ`HqZlCLDU4GfSz&a(cOIeF&w+y9x@@4*=m$tqP
z#*!;CxJ_Y)vtqpmEBc@p6+@%y+%SNHiDYXNodZOaM};}OC`!es#N9B0jC1b`l$|8k
zUB^6c%(2!ZY3->W-Ri*2`bPSSoRfv{PIbPzCrk~Sj0@P6xOwtpLu7vWgf^B^KczN3(
z_AV1qqFErlDKPC3bDrGr4tvy0-lj?o-3)`@EsQY$9PLR*SLTJjj}J&rYN|x-BmhjH
z&20vq>pa8~i0N_rG=&`A`yInJw#%Zi?sP6H0E3O4LOW5ghnW$yP}cq_CTlcQ1)UD9
zBgrn}BLJ$YLQ`Uq
zkI5*7riM}eqw5vjEWdHgJ20yZ7D*>9Ub^z@ixgyA?TWch!JP@l;Oe&r_Kxrcx_=j?QAN%0!_dwH|t$1JV+16SasizCubL-z`jy6Q4QhB?z%t&jsW1zr93(aF-y`
z4m@AW#Q|6=31T-biHzVL?nfc!~j|fJW{&1Y%w?sAeSd^qR!cFg8m!Kgwbl-%aR$;V&%PZs4I
zqvIncv~Jrre{`dx=Yk9LC@UhBpq%bkoZ**Gs&#<+ub#`jr*9>nE(AH}yw=G{!M!9Z
z6}!`-m-qHNfIpa=ylccG&9%lLG=WLHKXW>Dauv%Xrq~DT52ZguvS@-W>N#bvtNeO?
z8O4NxP_0h@Xkiex`ohW?nGVJ`rW?TctkmHygsp2@P27n0g;*wjGiJSx(EiL4Q_
zs`3iSIhE#7`Od`%qly}mL0FLT@Ix<7_wnP;q&>gnIR<|TyV!O5HdYhjV9i@z#
zN_u{InJho)()BMk9)Jzs(_0m#0}X0XNG2&>9=snRKO!)VW}wccp#g%o(APgOT2p)i
zHUdlhC!cQ}9490LOyY^SJgoJ&vy1SDQR-s?ONR&b?Zo7fm^hZ=cK0RwrJhv&);|(}
zy?icV5MIZXC61&$xQ|TDmk(-@J^kYQSQA0Un(^SC?AlG=8OPjwLT%jT5^Z>`angQS
z#eNZ?Us3Ve`}B0l#ht7O?e#HDPMm~For?~K!1NS=Ocg~)9H$;w_QQ+XIF^3CPZu(_QZ$1g5fP*3f%S=XBUB#|xwN^1fT
z6nC;a*V-u~b>nWP956Frb16D;%!8nH0M&<;xeRh6TIV7LL32;+NGk%;DwD)R+kC{Dn3Vt$JllKvhAeb8ox?H)Cc
z8=$!Bn>D3y05Le6RdNf)CG;5>C=ZP9C_hVC;~){dZBTguP(h4b-wO#*)Zy*{K;?#;
zs$n1`$0G!|5eBO8AQ9kQ1O1(>{Eem9B06>w2+z`2K0-^Futp6X
zNl-~TBE7{bA*Q0(5urcL;)d>2HWHu^Rp|8BY7JpfkbEdrnV7^w1g
zJcovw#2R*L0KUCW`}eg9eim*48nvn#p--!dU@R>NbEd43%I>=N`q-cq;9@nns~K$(
zSkiRhY#`YeTv_m4V)~n4(5U|L!FyWgK4{F1C|Z=?1VHX^+U-kIx(due|Gc``FN`Lq
zJ$WXbJV98F7(N&uu8LJcmO#P9c_&Qj18WTZbJ+T7+!8=ruJ66t|Hwy_nc4*)L&BuW
z|IF4m-$}K;Rp32FiL5()yXlpPv4|a-?nnixhLs39=pk=48i^z(-@2o4e~X|e;OxBb
z{<3jef%2^4x>9XmQE1lyI_>eQ)d?p706TJ85GHki
zK*4Hy-HYb$N99c@eH0P++A_Up2_hETSgI;6l`2+X+$w#m!E3Crsr-;&Akay|%gt;L
zlB&>CZA!?Z`=h5SeU%=a>i`)KON2%6wJfXlu-|nZuWaxoXV3t%{Jn+6zIz-^{(bAv
z$z)b3p}hR;B07kbX4)-}sisGT{iBpHf-)d1?RjqZBQMzuioX%rYUHo`1I8Xdb+$
z9PyftY*n0+d`;arC>lbCfdPGtk`%|Zy+!#9eJs9<1JYIB9BYd88J(zj*jhB}NWlnA
z5bg2Wj=y-(WPCfZ-G$C({@S2srZH6cSPJu!)*M)
zAI#N=@%sGU*11Puy>Jp<^Tvh~QlrUGJe8Z6fB9zsnGkT2@W3@BFXQI)Xkqu@sXZvMY7KDs9x
zF5V?tgd0KI`vjR&QUT)nfK0xHp(cS9?Jib28={T?{!D`5{rG&u2Oz&WtlGURYh4F;
z>mT{fPhQBuAOywMx(zbyuw75q^^@lzn06_^Gww_KtML%Jhqi#Q_I=3YlK2W{NDD`q
zS*L^3!Gsm%mLUDD!xr)HZ9xKo+{tBk%)#vM8Lh?~_nDS{0-h6yAC`pxLDO&Tep3OF
zjxa95>`!FebOSw-=GIIV*3)7hl76~pc|7A>D%h+CTozoJgL40Rzi;{OpSFH0HN#M?s+|{%~kf}DZWI(zsUAe-5u^fLn1VAp|oms
z(q|N1WG@-`t#rPci38&IxP>>t+iF^OCJYGo+N#Y_)&mf148HHFrSl~5@{+^137}_O
ztzpH;Fd%|A-i>2IZ@w+5WpcNx1m=s;K{e
z0L;)I#|g|YMvTk+Ho^ZwDc0(Ff4M#LFwr!C{8`c@boAM71R<%M(TH!7hbQPr5#|U<
zY&Sl91^Iib%*jn#H0Q}5_Xs%Rgg>SXc!bZ*!(s_07w|wrlZ4->(ZxQszY712-mYcm
zTXneB-$U>a58sDd^WW<$3u;XO{{ejZKwrmH|F87`y!3u8pWvXjfm%oX-?Ipo)yf%3
zpTDjjN}-M&47e9HUK{^c$w+$gi`YM_A>IGgP*`'s distributions
are not specified to be repeatable across different platforms.**
----
-[Home](Readme.md#top)
diff --git a/docs/list-of-examples.md b/docs/list-of-examples.md
index a919408adf..aa6a75f6c9 100644
--- a/docs/list-of-examples.md
+++ b/docs/list-of-examples.md
@@ -3,44 +3,86 @@
## Already available
-- Test Case: [Single-file](../examples/010-TestCase.cpp)
-- Test Case: [Multiple-file 1](../examples/020-TestCase-1.cpp), [2](../examples/020-TestCase-2.cpp)
-- Assertion: [REQUIRE, CHECK](../examples/030-Asn-Require-Check.cpp)
-- Fixture: [Sections](../examples/100-Fix-Section.cpp)
-- Fixture: [Class-based fixtures](../examples/110-Fix-ClassFixture.cpp)
-- BDD: [SCENARIO, GIVEN, WHEN, THEN](../examples/120-Bdd-ScenarioGivenWhenThen.cpp)
-- Listener: [Listeners](../examples/210-Evt-EventListeners.cpp)
-- Configuration: [Provide your own output streams](../examples/231-Cfg-OutputStreams.cpp)
-- Generators: [Create your own generator](../examples/300-Gen-OwnGenerator.cpp)
-- Generators: [Use map to convert types in GENERATE expression](../examples/301-Gen-MapTypeConversion.cpp)
-- Generators: [Run test with a table of input values](../examples/302-Gen-Table.cpp)
-- Generators: [Use variables in generator expressions](../examples/310-Gen-VariablesInGenerators.cpp)
-- Generators: [Use custom variable capture in generator expressions](../examples/311-Gen-CustomCapture.cpp)
+### Test Case: Single-file
+```cpp
+--8<-- "examples/010-TestCase.cpp"
+```
+### Test Case: Multiple-files
+=== "File 1"
+ ```cpp
+ --8<-- "examples/020-TestCase-1.cpp"
+ ```
+=== "File 2"
+ ```cpp
+ --8<-- "examples/020-TestCase-2.cpp"
+ ```
+### Assertion (REQUIRE, CHECK)
+```cpp
+--8<-- "examples/030-Asn-Require-Check.cpp"
+```
+### Fixtures
+#### Sections
+```cpp
+--8<-- "examples/100-Fix-Section.cpp"
+```
+#### Class-based fixtures
+```cpp
+--8<-- "examples/110-Fix-ClassFixture.cpp"
+```
+### BDD (SCENARIO, GIVEN, WHEN, THEN)
+```cpp
+--8<-- "examples/120-Bdd-ScenarioGivenWhenThen.cpp"
+```
+### Listener
+```cpp
+--8<-- "examples/210-Evt-EventListeners.cpp"
+```
+### Configuration - *Provide your own output streams*
+```cpp
+--8<-- "examples/231-Cfg-OutputStreams.cpp"
+```
+### Generators
+#### Create your own generator
+```cpp
+--8<-- "examples/300-Gen-OwnGenerator.cpp"
+```
+#### Use map to convert types in GENERATE expression
+```cpp
+--8<-- "examples/301-Gen-MapTypeConversion.cpp"
+```
+#### Run test with a table of input values
+```cpp
+--8<-- "examples/302-Gen-Table.cpp"
+```
+#### Use variables in generator expressions
+```cpp
+--8<-- "examples/310-Gen-VariablesInGenerators.cpp"
+```
+#### Use custom variable capture in generator expressions
+```cpp
+--8<-- "examples/311-Gen-CustomCapture.cpp"
+```
+??? note "Planned (TBD)"
+
+ - Assertion: [REQUIRE_THAT and Matchers](../examples/040-Asn-RequireThat.cpp)
+ - Assertion: [REQUIRE_NO_THROW](../examples/050-Asn-RequireNoThrow.cpp)
+ - Assertion: [REQUIRE_THROWS](../examples/050-Asn-RequireThrows.cpp)
+ - Assertion: [REQUIRE_THROWS_AS](../examples/070-Asn-RequireThrowsAs.cpp)
+ - Assertion: [REQUIRE_THROWS_WITH](../examples/080-Asn-RequireThrowsWith.cpp)
+ - Assertion: [REQUIRE_THROWS_MATCHES](../examples/090-Asn-RequireThrowsMatches.cpp)
+ - Floating point: [Approx - Comparisons](../examples/130-Fpt-Approx.cpp)
+ - Logging: [CAPTURE - Capture expression](../examples/140-Log-Capture.cpp)
+ - Logging: [INFO - Provide information with failure](../examples/150-Log-Info.cpp)
+ - Logging: [WARN - Issue warning](../examples/160-Log-Warn.cpp)
+ - Logging: [FAIL, FAIL_CHECK - Issue message and force failure/continue](../examples/170-Log-Fail.cpp)
+ - Logging: [SUCCEED - Issue message and continue](../examples/180-Log-Succeed.cpp)
+ - Report: [User-defined type](../examples/190-Rpt-ReportUserDefinedType.cpp)
+ - Report: [User-defined reporter](../examples/202-Rpt-UserDefinedReporter.cpp)
+ - Report: [Automake reporter](../examples/205-Rpt-AutomakeReporter.cpp)
+ - Report: [TAP reporter](../examples/206-Rpt-TapReporter.cpp)
+ - Report: [Multiple reporter](../examples/208-Rpt-MultipleReporters.cpp)
+ - Configuration: [Provide your own main()](../examples/220-Cfg-OwnMain.cpp)
+ - Configuration: [Compile-time configuration](../examples/230-Cfg-CompileTimeConfiguration.cpp)
+ - Configuration: [Run-time configuration](../examples/240-Cfg-RunTimeConfiguration.cpp)
-## Planned
-
-- Assertion: [REQUIRE_THAT and Matchers](../examples/040-Asn-RequireThat.cpp)
-- Assertion: [REQUIRE_NO_THROW](../examples/050-Asn-RequireNoThrow.cpp)
-- Assertion: [REQUIRE_THROWS](../examples/050-Asn-RequireThrows.cpp)
-- Assertion: [REQUIRE_THROWS_AS](../examples/070-Asn-RequireThrowsAs.cpp)
-- Assertion: [REQUIRE_THROWS_WITH](../examples/080-Asn-RequireThrowsWith.cpp)
-- Assertion: [REQUIRE_THROWS_MATCHES](../examples/090-Asn-RequireThrowsMatches.cpp)
-- Floating point: [Approx - Comparisons](../examples/130-Fpt-Approx.cpp)
-- Logging: [CAPTURE - Capture expression](../examples/140-Log-Capture.cpp)
-- Logging: [INFO - Provide information with failure](../examples/150-Log-Info.cpp)
-- Logging: [WARN - Issue warning](../examples/160-Log-Warn.cpp)
-- Logging: [FAIL, FAIL_CHECK - Issue message and force failure/continue](../examples/170-Log-Fail.cpp)
-- Logging: [SUCCEED - Issue message and continue](../examples/180-Log-Succeed.cpp)
-- Report: [User-defined type](../examples/190-Rpt-ReportUserDefinedType.cpp)
-- Report: [User-defined reporter](../examples/202-Rpt-UserDefinedReporter.cpp)
-- Report: [Automake reporter](../examples/205-Rpt-AutomakeReporter.cpp)
-- Report: [TAP reporter](../examples/206-Rpt-TapReporter.cpp)
-- Report: [Multiple reporter](../examples/208-Rpt-MultipleReporters.cpp)
-- Configuration: [Provide your own main()](../examples/220-Cfg-OwnMain.cpp)
-- Configuration: [Compile-time configuration](../examples/230-Cfg-CompileTimeConfiguration.cpp)
-- Configuration: [Run-time configuration](../examples/240-Cfg-RunTimeConfiguration.cpp)
-
----
-
-[Home](Readme.md#top)
diff --git a/docs/logging.md b/docs/logging.md
index dbd4f912ad..6ab809dc5e 100644
--- a/docs/logging.md
+++ b/docs/logging.md
@@ -154,6 +154,4 @@ to enclose the expression inside parentheses:
`CAPTURE( (std::pair{1, 2}) );`
----
-[Home](Readme.md#top)
diff --git a/docs/matchers.md b/docs/matchers.md
index 14c1589821..425b9033d9 100644
--- a/docs/matchers.md
+++ b/docs/matchers.md
@@ -435,6 +435,4 @@ and new style matchers arbitrarily.
> `MatcherGenericBase` lives in `catch2/matchers/catch_matchers_templated.hpp`
----
-[Home](Readme.md#top)
diff --git a/docs/migrate-v2-to-v3.md b/docs/migrate-v2-to-v3.md
index 84ed76904a..204be8d537 100644
--- a/docs/migrate-v2-to-v3.md
+++ b/docs/migrate-v2-to-v3.md
@@ -93,6 +93,4 @@ the [interfaces](reporters.md#top) and the [events](reporter-events.md#top)
are now documented.
----
-[Home](Readme.md#top)
diff --git a/docs/opensource-users.md b/docs/opensource-users.md
index a02d0b98e2..9714c48440 100644
--- a/docs/opensource-users.md
+++ b/docs/opensource-users.md
@@ -154,6 +154,4 @@ SpECTRE is a code for multi-scale, multi-physics problems in astrophysics and gr
### [Standardese](https://github.com/foonathan/standardese)
Standardese aims to be a nextgen Doxygen.
----
-[Home](Readme.md#top)
diff --git a/docs/own-main.md b/docs/own-main.md
index 26dfa86da6..efbef7e9ef 100644
--- a/docs/own-main.md
+++ b/docs/own-main.md
@@ -127,6 +127,4 @@ part of the version. As an example, given single header version v2.3.4,
the macros would expand into `2`, `3`, and `4` respectively.
----
-[Home](Readme.md#top)
diff --git a/docs/release-notes.md b/docs/release-notes.md
index 8b413b1560..2643a60666 100644
--- a/docs/release-notes.md
+++ b/docs/release-notes.md
@@ -1659,6 +1659,4 @@ Other:
## Even Older versions
Release notes were not maintained prior to v1.6.0, but you should be able to work them out from the Git history
----
-[Home](Readme.md#top)
diff --git a/docs/reporter-events.md b/docs/reporter-events.md
index 015f67be4f..6d028a0a9a 100644
--- a/docs/reporter-events.md
+++ b/docs/reporter-events.md
@@ -170,6 +170,4 @@ or Windows SE handler is called into with a fatal signal/exception.
`noMatchingTestCases` is sent for each user provided test specification
that did not match any registered tests.
----
-[Home](Readme.md#top)
diff --git a/docs/reporters.md b/docs/reporters.md
index 496c61a925..2c28f2560d 100644
--- a/docs/reporters.md
+++ b/docs/reporters.md
@@ -208,6 +208,4 @@ important for the reporter to work _nicely_.
----
-[Home](Readme.md#top)
diff --git a/docs/skipping-passing-failing.md b/docs/skipping-passing-failing.md
index 4300d9d320..7c8240e273 100644
--- a/docs/skipping-passing-failing.md
+++ b/docs/skipping-passing-failing.md
@@ -124,6 +124,4 @@ TEST_CASE( "FAIL showcase" ) {
```
----
-[Home](Readme.md#top)
diff --git a/docs/test-cases-and-sections.md b/docs/test-cases-and-sections.md
index acebcc51d7..7a02c26d83 100644
--- a/docs/test-cases-and-sections.md
+++ b/docs/test-cases-and-sections.md
@@ -341,6 +341,4 @@ TEMPLATE_PRODUCT_TEST_CASE_SIG("A Template product test case with array signatur
```
----
-[Home](Readme.md#top)
diff --git a/docs/test-fixtures.md b/docs/test-fixtures.md
index 9c9eaa18c0..56387e7bc1 100644
--- a/docs/test-fixtures.md
+++ b/docs/test-fixtures.md
@@ -157,6 +157,4 @@ TEMPLATE_LIST_TEST_CASE_METHOD(Template_Fixture,
}
```
----
-[Home](Readme.md#top)
diff --git a/docs/tostring.md b/docs/tostring.md
index adce3cc764..1c6d563839 100644
--- a/docs/tostring.md
+++ b/docs/tostring.md
@@ -127,6 +127,4 @@ inside the `StringMaker` specialization, like so:
This assertion will fail and print out the `testFloat1` and `testFloat2`
to 15 decimal places.
----
-[Home](Readme.md#top)
diff --git a/docs/tutorial.md b/docs/tutorial.md
index 342c738181..576373be9f 100644
--- a/docs/tutorial.md
+++ b/docs/tutorial.md
@@ -222,6 +222,4 @@ about these as you go, in the ever-growing [reference section](Readme.md#top)
of the documentation.
----
-[Home](Readme.md#top)
diff --git a/docs/usage-tips.md b/docs/usage-tips.md
index 6be01ee632..b1949ba676 100644
--- a/docs/usage-tips.md
+++ b/docs/usage-tips.md
@@ -95,6 +95,4 @@ and makes tests easy to navigate by reflecting the project's organizational
structure.
----
-[Home](Readme.md#top)
diff --git a/docs/why-catch.md b/docs/why-catch.md
index 2c0178ca5d..e938c2bbeb 100644
--- a/docs/why-catch.md
+++ b/docs/why-catch.md
@@ -54,6 +54,4 @@ for some idea on who else also uses Catch2.
See the [tutorial](tutorial.md#top) to get more of a taste of using
Catch2 in practice.
----
-[Home](Readme.md#top)
diff --git a/mkdocs.yml b/mkdocs.yml
index d0221340a5..b6eb925aba 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -25,8 +25,8 @@ theme:
font:
text: Open Sans
code: Fira Code
- logo: assets/catch2_logo_with_bg.png
- favicon: assets/c2_hand_logo.png
+ logo: https://github.com/catchorg/Catch2/blob/devel/data/artwork/catch2-logo-small-with-background.png?raw=true
+ favicon: https://github.com/catchorg/Catch2/blob/devel/data/artwork/catch2-hand-logo.png?raw=true
plugins:
@@ -34,9 +34,6 @@ plugins:
- mike
-
-
-
markdown_extensions:
- def_list
- pymdownx.tasklist:
@@ -51,6 +48,9 @@ markdown_extensions:
- pymdownx.details
- admonition
- tables
+ - pymdownx.superfences
+ - pymdownx.tabbed:
+ alternate_style: true
- toc:
permalink: "#"
From 6e1e2f62e8cc92b76429d2412b171c5bd442b23e Mon Sep 17 00:00:00 2001
From: Nir <88795475+nrbnlulu@users.noreply.github.com>
Date: Mon, 29 May 2023 10:14:39 +0300
Subject: [PATCH 4/5] update contributing.md
---
docs/contributing.md | 14 ++++++++++++++
1 file changed, 14 insertions(+)
diff --git a/docs/contributing.md b/docs/contributing.md
index faaafa28c4..c5f47593e5 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -135,6 +135,20 @@ other people can use it as well. This section collects some technical
information that you will need for updating Catch2's documentation, and
possibly some generic advise as well.
+We use mkdocs for documentation and poetry for python environment.
+first install poetry (you'll need python...)
+```console
+pip install poetry
+```
+Poetry will install our docs dependencies
+```console
+poetry install
+```
+serve the docs locally to see your changes
+```console
+poetry run mkdocs serve
+```
+
### Technicalities
From 99b6056967a7a7bda4dd97a6fdd23c70c3809dd6 Mon Sep 17 00:00:00 2001
From: Nir <88795475+nrbnlulu@users.noreply.github.com>
Date: Sun, 11 Jun 2023 21:31:41 +0300
Subject: [PATCH 5/5] fix lists
---
docs/Readme.md | 79 +++++++++++++++++++++++++++-----------------------
1 file changed, 42 insertions(+), 37 deletions(-)
diff --git a/docs/Readme.md b/docs/Readme.md
index d84b4bfdcc..c5afd0bd02 100644
--- a/docs/Readme.md
+++ b/docs/Readme.md
@@ -4,40 +4,45 @@
To get the most out of Catch2, start with the [tutorial](tutorial.md#top).
Once you're up and running consider the following reference material.
-**Writing tests:**
-* [Assertion macros](assertions.md#top)
-* [Matchers (asserting complex properties)](matchers.md#top)
-* [Comparing floating point numbers](comparing-floating-point-numbers.md#top)
-* [Logging macros](logging.md#top)
-* [Test cases and sections](test-cases-and-sections.md#top)
-* [Test fixtures](test-fixtures.md#top)
-* [Explicitly skipping, passing, and failing tests at runtime](skipping-passing-failing.md#top)
-* [Reporters (output customization)](reporters.md#top)
-* [Event Listeners](event-listeners.md#top)
-* [Data Generators (value parameterized tests)](generators.md#top)
-* [Other macros](other-macros.md#top)
-* [Micro benchmarking](benchmarks.md#top)
-
-**Fine tuning:**
-* [Supplying your own main()](own-main.md#top)
-* [Compile-time configuration](configuration.md#top)
-* [String Conversions](tostring.md#top)
-
-**Running:**
-* [Command line](command-line.md#top)
-
-**Odds and ends:**
-* [Frequently Asked Questions (FAQ)](faq.md#top)
-* [Best practices and other tips](usage-tips.md#top)
-* [CMake integration](cmake-integration.md#top)
-* [Tooling integration (CI, test runners, other)](ci-and-misc.md#top)
-* [Known limitations](limitations.md#top)
-
-**Other:**
-* [Why Catch2?](why-catch.md#top)
-* [Migrating from v2 to v3](migrate-v2-to-v3.md#top)
-* [Open Source Projects using Catch2](opensource-users.md#top)
-* [Commercial Projects using Catch2](commercial-users.md#top)
-* [Contributing](contributing.md#top)
-* [Release Notes](release-notes.md#top)
-* [Deprecations and incoming changes](deprecations.md#top)
+**Writing tests:**
+
+- [Assertion macros](assertions.md#top)
+- [Matchers (asserting complex properties)](matchers.md#top)
+- [Comparing floating point numbers](comparing-floating-point-numbers.md#top)
+- [Logging macros](logging.md#top)
+- [Test cases and sections](test-cases-and-sections.md#top)
+- [Test fixtures](test-fixtures.md#top)
+- [Explicitly skipping, passing, and failing tests at runtime](skipping-passing-failing.md#top)
+- [Reporters (output customization)](reporters.md#top)
+- [Event Listeners](event-listeners.md#top)
+- [Data Generators (value parameterized tests)](generators.md#top)
+- [Other macros](other-macros.md#top)
+- [Micro benchmarking](benchmarks.md#top)
+
+**Fine tuning:**
+
+- [Supplying your own main()](own-main.md#top)
+- [Compile-time configuration](configuration.md#top)
+- [String Conversions](tostring.md#top)
+
+**Running:**
+
+- [Command line](command-line.md#top)
+
+**Odds and ends:**
+
+- [Frequently Asked Questions (FAQ)](faq.md#top)
+- [Best practices and other tips](usage-tips.md#top)
+- [CMake integration](cmake-integration.md#top)
+- [Tooling integration (CI, test runners, other)](ci-and-misc.md#top)
+- [Known limitations](limitations.md#top)
+
+**Other:**
+
+- [Why Catch2?](why-catch.md#top)
+- [Migrating from v2 to v3](migrate-v2-to-v3.md#top)
+- [Open Source Projects using Catch2](opensource-users.md#top)
+- [Commercial Projects using Catch2](commercial-users.md#top)
+- [Contributing](contributing.md#top)
+- [Release Notes](release-notes.md#top)
+- [Deprecations and incoming changes](deprecations.md#top)