|
@@ -95,9 +95,15 @@ This task accepts the following arguments:
|
|
|
|
|
|
|
|
* `--skip-api` – Skips building the API documentation (which takes the majority of the total time).
|
|
* `--skip-api` – Skips building the API documentation (which takes the majority of the total time).
|
|
|
* `--skip-snippets` – Skips building live snippets.
|
|
* `--skip-snippets` – Skips building live snippets.
|
|
|
-* `--snippets=snippet-name` – Snippets to build (accepts glob patterns). If a snippet that you want to build uses another snippet as a source that provides an editor instance, you need to specify both snippets. See examples:
|
|
|
|
|
- - `--snippets=features/*` - all snippets that starts with `features/` in their names will be built,
|
|
|
|
|
- - `--snippets=classic-editor,build-classic-source` - all snippets that contains the specified strings in their names will be built.
|
|
|
|
|
|
|
+* `--snippets=snippet-name` – Snippets to build. Accepts glob patterns that are matched against snippet names used in `{@snippet ...}` tags. Examples:
|
|
|
|
|
+
|
|
|
|
|
+ ```
|
|
|
|
|
+ --snippets=image // matches roughly {@snippet *image*}
|
|
|
|
|
+ --snippets="features/*" // matches roughly {@snippet *features/*}
|
|
|
|
|
+ --snippets=classic-editor,build-classic-source
|
|
|
|
|
+ ```
|
|
|
|
|
+
|
|
|
|
|
+ Note: If a snippet that you want to build uses another snippet as a source that provides an editor instance, you need to specify both snippets (e.g. `--files=features/default-headings,build-classic-source`).
|
|
|
* `--skip-validation` – Skips the final link validation.
|
|
* `--skip-validation` – Skips the final link validation.
|
|
|
* `--watch` – Runs the documentation generator in a watch mode. It covers guides but it does not cover API docs.
|
|
* `--watch` – Runs the documentation generator in a watch mode. It covers guides but it does not cover API docs.
|
|
|
* `--production` – Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.
|
|
* `--production` – Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.
|