Skip to content

Commit

Permalink
Docs: Moved the bit about generating content styles to the 'Developme…
Browse files Browse the repository at this point in the history
…nt environment' guide.
  • Loading branch information
oleq committed Aug 13, 2019
1 parent 0f0a100 commit 65a56b6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 16 deletions.
17 changes: 1 addition & 16 deletions docs/builds/guides/integration/content-styles.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,7 @@ By default, content styles are loaded by the editor JavaScript which makes them
To avoid unnecessary dependencies in your front–end use a stylesheet with a complete list of CKEditor 5 content styles used by all editor features. There are two ways to obtain it:

* By taking it directly from [this guide](#the-full-list-of-content-styles) and saving it as a static resource in your application (e.g. `content-styles.css`) (**recommended**).
* By generating it using the `yarn docs:content-styles` script in the [root package](https://github.com/ckeditor/ckeditor5) of the editor:
```shell
> git clone git@github.com:ckeditor/ckeditor5.git
Cloning into 'ckeditor5'...
...
> yarn
yarn install v1.16.0
[1/5] 🔍 Validating package.json...
[2/5] 🔍 Resolving packages...
[3/5] 🚚 Fetching packages...
...
> yarn docs:content-styles
yarn run v1.16.0
$ node ./scripts/docs/build-content-styles.js
Content styles have been extracted to /path/to/ckeditor5/build/content-styles/content-styles.css
```
* By generating it using a dedicated script. Learn more in the {@link framework/guides/contributing/development-environment#generating-content-styles "Development environment"} guide.

Load the `content-styles.css` file in your application by adding the following code to the template:

Expand Down
4 changes: 4 additions & 0 deletions docs/framework/guides/contributing/development-environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,6 +223,10 @@ Note: These arguments must be passed after additional `--`:
yarn run docs --skip-api
```

## Generating content styles

It is possible to generate a stylesheet containing content styles brought by all CKEditor 5 features. Execute `yarn docs:content-styles` and the stylesheet will be saved in the `build/content-styles` folder. To learn more, please refer to the {@link builds/guides/integration/content-styles "Content styles"} guide.

## Bisecting through a multi-repository

CKEditor 5 is a multi-repository project. It means that [`git bisect`](https://git-scm.com/docs/git-bisect) (which is super handy when tracking which commit introduced a bug) will not work out of the box.
Expand Down

0 comments on commit 65a56b6

Please sign in to comment.