Skip to content

Commit

Permalink
2.5.3
Browse files Browse the repository at this point in the history
  • Loading branch information
Aschen committed Mar 23, 2023
1 parent 31d46c8 commit 9c5d6b3
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 29 deletions.
49 changes: 23 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,43 +10,39 @@ This is an internal tool used by the Kuzzle team to build the documentation of a
[![License](https://img.shields.io/npm/l/kdoc.svg)](https://github.com/kuzzleio/kdoc/blob/master/package.json)

<!-- toc -->

- [kuzdoc](#kuzdoc)
- [Usage](#usage)
- [Commands](#commands)
* [kuzdoc](#kuzdoc)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Usage

<!-- usage -->

```sh-session
$ npm install -g kuzdoc
$ kuzdoc COMMAND
running command...
$ kuzdoc (-v|--version|version)
kuzdoc/2.5.1 linux-x64 node-v14.17.0
kuzdoc/2.5.3 linux-x64 node-v14.20.0
$ kuzdoc --help [COMMAND]
USAGE
$ kuzdoc COMMAND
...
```

<!-- usagestop -->

# Commands

<!-- commands -->

- [`kuzdoc add-repo`](#kuzdoc-add-repo)
- [`kuzdoc add-section`](#kuzdoc-add-section)
- [`kuzdoc build-and-deploy`](#kuzdoc-build-and-deploy)
- [`kuzdoc dead-links`](#kuzdoc-dead-links)
- [`kuzdoc dev`](#kuzdoc-dev)
- [`kuzdoc generate:js FILEPATH`](#kuzdoc-generatejs-filepath)
- [`kuzdoc help [COMMAND]`](#kuzdoc-help-command)
- [`kuzdoc install`](#kuzdoc-install)
- [`kuzdoc local-deploy`](#kuzdoc-local-deploy)
* [`kuzdoc add-repo`](#kuzdoc-add-repo)
* [`kuzdoc add-section`](#kuzdoc-add-section)
* [`kuzdoc build-and-deploy`](#kuzdoc-build-and-deploy)
* [`kuzdoc dead-links`](#kuzdoc-dead-links)
* [`kuzdoc dev`](#kuzdoc-dev)
* [`kuzdoc generate:js FILEPATH`](#kuzdoc-generatejs-filepath)
* [`kuzdoc help [COMMAND]`](#kuzdoc-help-command)
* [`kuzdoc install`](#kuzdoc-install)
* [`kuzdoc local-deploy`](#kuzdoc-local-deploy)

## `kuzdoc add-repo`

Expand All @@ -63,7 +59,7 @@ DESCRIPTION
NOTE: This command must be executed from the root of the framework meta-repo.
```

_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/add-repo.ts)_
_See code: [src/commands/add-repo.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/add-repo.ts)_

## `kuzdoc add-section`

Expand All @@ -80,7 +76,7 @@ DESCRIPTION
NOTE: This command must be executed from the root of the framework meta-repo.
```

_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/add-section.ts)_
_See code: [src/commands/add-section.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/add-section.ts)_

## `kuzdoc build-and-deploy`

Expand All @@ -100,6 +96,8 @@ OPTIONS
--dryRun Only builds the repo without deploying it
--noInvalidation Do not invalidate the Cloudfront distribution
--repo=repo The list of repositories to build, or the value __ALL__ to build all repos.
If not specified, kuzdoc will ask a prompt.
Expand All @@ -121,7 +119,7 @@ DESCRIPTION
be properly set.
```

_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/build-and-deploy.ts)_
_See code: [src/commands/build-and-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/build-and-deploy.ts)_

## `kuzdoc dead-links`

Expand Down Expand Up @@ -150,7 +148,7 @@ DESCRIPTION
The repository must be previously installed in the framework via the "install" command.
```

_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/dead-links.ts)_
_See code: [src/commands/dead-links.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/dead-links.ts)_

## `kuzdoc dev`

Expand All @@ -175,7 +173,7 @@ DESCRIPTION
variable, or via the interactive prompt (only the installed repositories are listed).
```

_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/dev.ts)_
_See code: [src/commands/dev.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/dev.ts)_

## `kuzdoc generate:js FILEPATH`

Expand All @@ -193,7 +191,7 @@ OPTIONS
--path=path [default: generated] Directory to write the doc
```

_See code: [src/commands/generate/js.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/generate/js.ts)_
_See code: [src/commands/generate/js.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/generate/js.ts)_

## `kuzdoc help [COMMAND]`

Expand Down Expand Up @@ -258,7 +256,7 @@ DESCRIPTION
repository is already present, the selected repository will be skipped and the folder will be left untouched.
```

_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/install.ts)_
_See code: [src/commands/install.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/install.ts)_

## `kuzdoc local-deploy`

Expand All @@ -279,6 +277,5 @@ DESCRIPTION
All the currently installed repositories will be built and deployed to the destination path.
```

_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.1/src/commands/local-deploy.ts)_

_See code: [src/commands/local-deploy.ts](https://github.com/kuzzleio/kuzdoc/blob/v2.5.3/src/commands/local-deploy.ts)_
<!-- commandsstop -->
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "kuzdoc",
"description": "The CLI that helps build the Kuzzle Docs",
"version": "2.5.2",
"version": "2.5.3",
"author": "The Kuzzle Team <[email protected]>",
"bin": {
"kuzdoc": "./bin/run"
Expand Down

0 comments on commit 9c5d6b3

Please sign in to comment.