Skip to content
This repository was archived by the owner on Apr 27, 2026. It is now read-only.

Commit b62e894

Browse files
committed
fix(docs-site): links on site index should work
1 parent c26a730 commit b62e894

18 files changed

Lines changed: 213 additions & 210 deletions

‎docs/core/executors/build.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,24 @@ Builds an app via the `dotnet` cli command.
1010

1111
## Options
1212

13-
### framework
14-
15-
- (string): Compiles for a specific framework. The framework must be defined in the project file
16-
17-
### version-suffix
18-
19-
- (string): Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.
20-
21-
### <span class="required">configuration</span>
13+
### <span className="required">configuration</span>
2214

2315
- (string): Defines the build configuration. The default for most projects is Debug, but you can override the build configuration settings in your project
2416

2517
Default: `"Debug"`
2618

19+
### extraParameters
20+
21+
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.
22+
2723
### force
2824

2925
- (boolean): Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
3026

27+
### framework
28+
29+
- (string): Compiles for a specific framework. The framework must be defined in the project file
30+
3131
### no-dependencies
3232

3333
- (boolean): Ignores project-to-project (P2P) references and only builds the specified root project.
@@ -54,6 +54,6 @@ Default: `"Debug"`
5454

5555
Default: `"minimal"`
5656

57-
### extraParameters
57+
### version-suffix
5858

59-
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.
59+
- (string): Sets the value of the $(VersionSuffix) property to use when building the project. This only works if the $(Version) property isn't set. Then, $(Version) is set to the $(VersionPrefix) combined with the $(VersionSuffix), separated by a dash.

‎docs/core/executors/format.md‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -10,56 +10,56 @@ Formats and lints a project using the dotnet-format tool
1010

1111
## Options
1212

13-
### noRestore
13+
### binarylog
1414

15-
- (boolean): Doesn't execute an implicit restore before formatting
15+
- (string): Log all project or solution load information to a binary log file.
1616

17-
### fixWhitespace
17+
### check
1818

19-
- (boolean): Run whitespace formatting. Run by default when not applying fixes.
19+
- (boolean): Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
2020

21-
### fixStyle
21+
Default: `true`
2222

23-
- (string): Run code style analyzers and apply fixes.
23+
### diagnostics
24+
25+
- (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
26+
27+
- (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
28+
29+
### exclude
30+
31+
- (array): A list of relative file or folder paths to exclude from formatting.
32+
33+
### fix
34+
35+
- (boolean): Formats files and saves changes to disk. Equivalent to setting --check=false.
2436

2537
### fixAnalyzers
2638

2739
- (string): Run 3rd party analyzers and apply fixes.
2840

29-
### diagnostics
41+
### fixStyle
3042

31-
- (string): A space separated list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
43+
- (string): Run code style analyzers and apply fixes.
3244

33-
- (array): A list of diagnostic ids to use as a filter when fixing code style or 3rd party analyzers.
45+
### fixWhitespace
46+
47+
- (boolean): Run whitespace formatting. Run by default when not applying fixes.
3448

3549
### include
3650

3751
- (array): A list of relative file or folder paths to include in formatting. All files are formatted if empty
3852

39-
### exclude
40-
41-
- (array): A list of relative file or folder paths to exclude from formatting.
42-
43-
### check
44-
45-
- (boolean): Formats files without saving changes to disk. Terminates with a non-zero exit code if any files were formatted.
53+
### noRestore
4654

47-
Default: `true`
55+
- (boolean): Doesn't execute an implicit restore before formatting
4856

4957
### report
5058

5159
- (string): Accepts a file path, which if provided, will produce a json report in the given directory.
5260

53-
### binarylog
54-
55-
- (string): Log all project or solution load information to a binary log file.
56-
5761
### verbosity
5862

5963
- (string): Set the verbosity level.
6064

6165
Default: `"minimal"`
62-
63-
### fix
64-
65-
- (boolean): Formats files and saves changes to disk. Equivalent to setting --check=false.

‎docs/core/executors/openapi-codegen.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,26 +10,26 @@ Invokes `nx g @nx-dotnet/core:swagger-typescript` with the proper parameters to
1010

1111
## Options
1212

13-
### useOpenApiGenerator
14-
15-
- (boolean): Use the OpenAPI generator to generate the code
13+
### <span className="required">openapiJsonPath</span>
1614

17-
### openApiGeneratorTemplate
15+
- (string): Path to OpenAPI spec file
1816

19-
- (string): The template to use for the OpenAPI generator
17+
### <span className="required">outputProject</span>
2018

21-
Default: `"typescript-fetch"`
19+
- (string): Which project should hold the generated code?
2220

2321
### openApiGeneratorArgs
2422

2523
- (array): Additional arguments to pass to the OpenAPI generator
2624

2725
Default: `["--global-property=models,apis"]`
2826

29-
### <span class="required">openapiJsonPath</span>
27+
### openApiGeneratorTemplate
3028

31-
- (string): Path to OpenAPI spec file
29+
- (string): The template to use for the OpenAPI generator
30+
31+
Default: `"typescript-fetch"`
3232

33-
### <span class="required">outputProject</span>
33+
### useOpenApiGenerator
3434

35-
- (string): Which project should hold the generated code?
35+
- (boolean): Use the OpenAPI generator to generate the code

‎docs/core/executors/publish.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,18 @@ Publishes an app via the `dotnet` cli command.
1616

1717
Default: `"Debug"`
1818

19-
### framework
19+
### extraParameters
2020

21-
- (string): Publishes the application for the specified target framework. You must specify the target framework in the project file.
21+
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.
2222

2323
### force
2424

2525
- (boolean): Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
2626

27+
### framework
28+
29+
- (string): Publishes the application for the specified target framework. You must specify the target framework in the project file.
30+
2731
### noBuild
2832

2933
- (boolean): Doesn't build the project before publishing. It also implicitly sets the --no-restore flag.
@@ -44,14 +48,18 @@ Default: `"Debug"`
4448

4549
- (string): Specifies the path for the output directory.
4650

47-
### selfContained
51+
### publishProfile
4852

49-
- (boolean): Publishes the .NET runtime with your application so the runtime doesn't need to be installed on the target machine. Default is true if a runtime identifier is specified and the project is an executable project (not a library project).
53+
- (string): Specifies the name of the publish profile to use while publishing. Do not include the file path or the file extension. MSBuild by default looks in the Properties/PublishProfiles folder and assumes the pubxml file extension.
5054

5155
### runtime
5256

5357
- (string): Publishes the application for a given runtime.
5458

59+
### selfContained
60+
61+
- (boolean): Publishes the .NET runtime with your application so the runtime doesn't need to be installed on the target machine. Default is true if a runtime identifier is specified and the project is an executable project (not a library project).
62+
5563
### verbosity
5664

5765
- (string): Sets the verbosity level of the command.
@@ -61,11 +69,3 @@ Default: `"minimal"`
6169
### versionSuffix
6270

6371
- (string): Defines the version suffix to replace the asterisk (\*) in the version field of the project file.
64-
65-
### publishProfile
66-
67-
- (string): Specifies the name of the publish profile to use while publishing. Do not include the file path or the file extension. MSBuild by default looks in the Properties/PublishProfiles folder and assumes the pubxml file extension.
68-
69-
### extraParameters
70-
71-
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.

‎docs/core/executors/serve.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@ Uses `dotnet watch` to run a .NET app.
1616

1717
Default: `"Debug"`
1818

19-
### framework
20-
21-
- (string): Builds and runs the app using the specified framework. The framework must be specified in the project file.
22-
2319
### force
2420

2521
- (boolean): Forces all dependencies to be resolved even if the last restore was successful. Specifying this flag is the same as deleting the project.assets.json file.
2622

23+
### framework
24+
25+
- (string): Builds and runs the app using the specified framework. The framework must be specified in the project file.
26+
2727
### launch-profile
2828

2929
- (string): The name of the launch profile (if any) to use when launching the application. Launch profiles are defined in the launchSettings.json file and are typically called Development, Staging, and Production. For more information, see Working with multiple environments.

‎docs/core/executors/test.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,6 @@ Runs test via the dotnet cli
1010

1111
## Options
1212

13-
### testAdapterPath
14-
15-
- (string): Path to a directory to be searched for additional test adapters. Only .dll files with suffix .TestAdapter.dll are inspected. If not specified, the directory of the test .dll is searched.
16-
1713
### blame
1814

1915
- (boolean): Runs the tests in blame mode. This option is helpful in isolating problematic tests that cause the test host to crash. When a crash is detected, it creates a sequence file in TestResults/&lt;Guid&gt;/&lt;Guid&gt;\_Sequence.xml that captures the order of tests that were run before the crash.
@@ -22,14 +18,14 @@ Runs test via the dotnet cli
2218

2319
- (boolean): Runs the tests in blame mode and collects a crash dump when the test host exits unexpectedly. This option depends on the version of .NET used, the type of error, and the operating system. For exceptions in managed code, a dump will be automatically collected on .NET 5.0 and later versions. It will generate a dump for testhost or any child process that also ran on .NET 5.0 and crashed. Crashes in native code will not generate a dump. This option works on Windows, macOS, and Linux. Crash dumps in native code, or when using .NET Core 3.1 or earlier versions, can only be collected on Windows, by using Procdump. A directory that contains procdump.exe and procdump64.exe must be in the PATH or PROCDUMP_PATH environment variable. Download the tools. Implies --blame. To collect a crash dump from a native application running on .NET 5.0 or later, the usage of Procdump can be forced by setting the VSTEST_DUMP_FORCEPROCDUMP environment variable to 1.
2420

25-
### blameCrashDumpType
26-
27-
- (string): The type of crash dump to be collected. Implies --blame-crash.
28-
2921
### blameCrashCollectAlways
3022

3123
- (boolean): Collects a crash dump on expected as well as unexpected test host exit.
3224

25+
### blameCrashDumpType
26+
27+
- (string): The type of crash dump to be collected. Implies --blame-crash.
28+
3329
### blameHang
3430

3531
- (boolean): Run the tests in blame mode and collects a hang dump when a test exceeds the given timeout.
@@ -47,28 +43,36 @@ Runs test via the dotnet cli
4743
5400000ms, 5400000mil, 5400000millisecond, 5400000milliseconds
4844
When no unit is used (for example, 5400000), the value is assumed to be in milliseconds. When used together with data driven tests, the timeout behavior depends on the test adapter used. For xUnit and NUnit the timeout is renewed after every test case. For MSTest, the timeout is used for all test cases. This option is supported on Windows with netcoreapp2.1 and later, on Linux with netcoreapp3.1 and later, and on macOS with net5.0 or later. Implies --blame and --blame-hang.
4945

50-
### configuration
51-
52-
- (string): Defines the build configuration. The default value is Debug, but your project's configuration could override this default SDK setting.
53-
5446
### collect
5547

5648
- (string): Enables data collector for the test run. For more information, see Monitor and analyze test run.
5749
To collect code coverage on any platform that is supported by .NET Core, install Coverlet and use the --collect:"XPlat Code Coverage" option.
5850
On Windows, you can collect code coverage by using the --collect "Code Coverage" option. This option generates a .coverage file, which can be opened in Visual Studio 2019 Enterprise. For more information, see Use code coverage and Customize code coverage analysis.
5951

52+
### configuration
53+
54+
- (string): Defines the build configuration. The default value is Debug, but your project's configuration could override this default SDK setting.
55+
6056
### diag
6157

6258
- (string): Enables diagnostic mode for the test platform and writes diagnostic messages to the specified file and to files next to it. The process that is logging the messages determines which files are created, such as _.host\_&lt;date&gt;.txt for test host log, and _.datacollector\_&lt;date&gt;.txt for data collector log.
6359

64-
### framework
60+
### extraParameters
6561

66-
- (string): Forces the use of dotnet or .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
62+
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.
6763

6864
### filter
6965

7066
- (string): Filters out tests in the current project using the given expression. For more information, see the Filter option details section. For more information and examples on how to use selective unit test filtering, see Running selective unit tests.
7167

68+
### framework
69+
70+
- (string): Forces the use of dotnet or .NET Framework test host for the test binaries. This option only determines which type of host to use. The actual framework version to be used is determined by the runtimeconfig.json of the test project. When not specified, the TargetFramework assembly attribute is used to determine the type of host. When that attribute is stripped from the .dll, the .NET Framework host is used.
71+
72+
### listTests
73+
74+
- (boolean): List the discovered tests instead of running the tests.
75+
7276
### logger
7377

7478
- (string): Specifies a logger for test results. Unlike MSBuild, dotnet test doesn't accept abbreviations: instead of -l "console;v=d" use -l "console;verbosity=detailed". Specify the parameter multiple times to enable multiple loggers.
@@ -97,9 +101,9 @@ Runs test via the dotnet cli
97101

98102
- (string): The .runsettings file to use for running the tests. The TargetPlatform element (x86|x64) has no effect for dotnet test. To run tests that target x86, install the x86 version of .NET Core. The bitness of the dotnet.exe that is on the path is what will be used for running tests. For more information, see the following resources:
99103

100-
### listTests
104+
### testAdapterPath
101105

102-
- (boolean): List the discovered tests instead of running the tests.
106+
- (string): Path to a directory to be searched for additional test adapters. Only .dll files with suffix .TestAdapter.dll are inspected. If not specified, the directory of the test .dll is searched.
103107

104108
### verbosity
105109

@@ -108,7 +112,3 @@ Runs test via the dotnet cli
108112
### watch
109113

110114
- (boolean): Determines if `dotnet test` or `dotnet watch test` is used to execute tests.
111-
112-
### extraParameters
113-
114-
- (string): Extra command-line arguments that are passed verbatim to the dotnet command.

‎docs/core/executors/update-swagger.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ Extract openapi swagger documentation from the webapi
1414

1515
- (string): Where should the swagger output be stored
1616

17-
### swaggerDoc
18-
19-
- (string): Which swagger doc should be used?
17+
### skipInstall
2018

21-
Default: `"v1"`
19+
- (boolean): Skips installing Swashbuckle.AspNetCore.Cli. This option should be used if you are managing the installation on your own.
2220

2321
### startupAssembly
2422

2523
- (string): Path from workspace root to the built api's startup dll file
2624

27-
### skipInstall
25+
### swaggerDoc
2826

29-
- (boolean): Skips installing Swashbuckle.AspNetCore.Cli. This option should be used if you are managing the installation on your own.
27+
- (string): Which swagger doc should be used?
28+
29+
Default: `"v1"`

0 commit comments

Comments
 (0)