Skip to content

Commit

Permalink
fix(nxdoc): include generator / executor description in detail file
Browse files Browse the repository at this point in the history
  • Loading branch information
AgentEnder committed May 23, 2021
1 parent ab15a41 commit b0bf601
Show file tree
Hide file tree
Showing 12 changed files with 24 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/core/executors/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## NxDotnet Build

Builds an app via the `dotnet` cli command.

## Options

### framework (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/executors/format.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Format executor

Formats and lints a project using the dotnet-format tool

## Options

### noRestore (boolean)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/executors/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## NxDotnet Publish

Publishes an app via the `dotnet` cli command.

## Options

### configuration (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/executors/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## NxDotnet Serve Executor

Uses `dotnet run` and chokidar to run a .NET app.

## Options

### configuration (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/generators/app.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## NxDotnet Application Generator

Generate a dotnet project under the application directory.

## Options

### name (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/generators/init.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @nx-dotnet/core:init

## Initialize NxDotnet

Update's user's gitignore file + initializes a blank config
2 changes: 2 additions & 0 deletions docs/core/generators/lib.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## NxDotnet Library Generator

Generate a dotnet project under the library directory.

## Options

### name (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/generators/nuget-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Nuget Reference

Add a nuget reference to a .NET project

## Options

### project (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/generators/project-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

## Project Reference Generator

Adds a project reference to the host project that points to the source project.

## Options

### project (string)
Expand Down
2 changes: 2 additions & 0 deletions docs/core/generators/restore.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @nx-dotnet/core:restore

## Restore Generator

Restores NuGet packages and .NET tools used by the workspace.
2 changes: 2 additions & 0 deletions docs/core/generators/sync.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# @nx-dotnet/core:sync

## Sync Generator

Syncs package versions across the workspace with nx-dotnet config.
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## <%= schema.title %><%}%>

<%=schema.description%>

<% if(Object.values(schema.properties).length > 0) {%>

## Options <% Object.entries(schema.properties).forEach(([property, config]) => {%>
Expand Down

0 comments on commit b0bf601

Please sign in to comment.