Skip to content

Commit

Permalink
docs(cli): add docs task (#1264)
Browse files Browse the repository at this point in the history
add the docs task to the cli documentation. also add a small intro for
the cli, to specify what it's for and how it's distributed
  • Loading branch information
rwaskiewicz authored Nov 6, 2023
1 parent 93c93e2 commit 2c0ef1c
Show file tree
Hide file tree
Showing 9 changed files with 54 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.0/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.1/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.2/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.3/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.4/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.5/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.6/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down
6 changes: 6 additions & 0 deletions versioned_docs/version-v4.7/config/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ slug: /cli

# Command Line Interface (CLI)

Stencil's command line interface (CLI) is how developers can build their projects, run tests, and more.
Stencil's CLI is included in the compiler, and can be invoked with the `stencil` command in a project where `@stencil/core` is installed.

## `stencil build`

Expand All @@ -33,6 +35,10 @@ Builds a Stencil project. The flags below are the available options for the `bui
| `--verbose` | Logs additional information about each step of the build. | |
| `--watch` | Watches files during development and triggers a rebuild when files are updated. | |

## `stencil docs`

Performs a one-time generation of documentation for your project.
For more information on documentation generation, please see the [Documentation Generation section](../documentation-generation/01-overview.md).

## `stencil test`

Expand Down

1 comment on commit 2c0ef1c

@vercel
Copy link

@vercel vercel bot commented on 2c0ef1c Nov 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

stencil-docs – ./

stencil-site.vercel.app
stencil-docs-ionic1.vercel.app
stencil-docs-git-main-ionic1.vercel.app

Please sign in to comment.