Skip to content

Commit 5340854

Browse files
committed
chore(docs): update TOC
1 parent 3149b41 commit 5340854

File tree

8 files changed

+50
-1
lines changed

8 files changed

+50
-1
lines changed

docs/input/guidelines/CakeContribIcon.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Title: CakeContrib-Icon
1313
- [Settings](#settings)
1414
- [Icon-Location](#icon-location)
1515
- [Icon include in project](#icon-include-in-project)
16-
- [migrating from an existing project](#migrating-from-an-existing-project)
16+
- [Migrating from an existing project](#migrating-from-an-existing-project)
1717

1818
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1919

docs/input/settings/fragments/IconDestinationLocation.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
The default location of the cake-contrib icon is `icon.png`, next to the csproj (i.e. `$(MSBuildProjectDirectory)/icon.png`).
29

310
Setting `CakeContribGuidelinesIconDestinationLocation` makes it possible to override the default location of the Icon. For example setting

docs/input/settings/fragments/IconOmitImport.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
The cake-contrib icon will be automatically included in the project, unless `CakeContribGuidelinesIconOmitImport` was defined.
29

310
To to use a "custom" import the following could be used:

docs/input/settings/fragments/OmitPrivateCheck.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
It it possible to opt-out of the check for `PrivateAssets` using the `CakeContribGuidelinesCakeReferenceOmitPrivateCheck` setting:
29

310
(*Keep in mind, though that it is not recommended to opt-out of this feature*)

docs/input/settings/fragments/OmitRecommendedConfigFile.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
It is possible to opt-out of the check for configuration-files by using the `CakeContribGuidelinesOmitRecommendedConfigFile` setting
29
and setting it's `Include` to the file name that should not be checked:
310

docs/input/settings/fragments/OmitRecommendedReference.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
It it possible to opt-out of the check for recommended references by using the `CakeContribGuidelinesOmitRecommendedReference` setting
29
and setting it's `Include` to the reference that should not be checked.
310

docs/input/settings/fragments/OmitTargetFramework.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
2+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
3+
4+
5+
6+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
7+
18
It it possible to opt-out of the check for target framework(s) by using the `CakeContribGuidelinesOmitTargetFramework` setting
29
and setting it's `Include` to the target framework that should not be checked.
310

docs/input/settings/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,15 @@ NoSidebar: true
99
## Table of Contents
1010

1111
- [General](#general)
12+
- [ProjectType](#projecttype)
1213
- [Icons](#icons)
14+
- [IconDestinationLocation](#icondestinationlocation)
15+
- [IconOmitImport](#iconomitimport)
1316
- [Opt-Out](#opt-out)
17+
- [OmitRecommendedConfigFile](#omitrecommendedconfigfile)
18+
- [OmitRecommendedReference](#omitrecommendedreference)
19+
- [OmitPrivateCheck](#omitprivatecheck)
20+
- [OmitTargetFramework](#omittargetframework)
1421

1522
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
1623

0 commit comments

Comments
 (0)