瀏覽代碼

Improved --snippets option in docs.

Kamil Piechaczek 5 年之前
父節點
當前提交
8f67f2c826
共有 1 個文件被更改,包括 3 次插入1 次删除
  1. 3 1
      docs/framework/guides/contributing/development-environment.md

+ 3 - 1
docs/framework/guides/contributing/development-environment.md

@@ -95,7 +95,9 @@ This task accepts the following arguments:
 
 * `--skip-api` – Skips building the API documentation (which takes the majority of the total time).
 * `--skip-snippets` – Skips building live snippets.
-* `--snippets=snippet-name` – Whitelists snippets to build (accepts glob patterns).
+* `--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.
 * `--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.
 * `--production` – Minifies the assets and performs other actions which are unnecessary during CKEditor 5 development.