Skip to content

Commit

Permalink
Merge pull request #17047 from ckeditor/ck/builder-redir
Browse files Browse the repository at this point in the history
Docs: updating Builder link.
  • Loading branch information
godai78 authored Sep 5, 2024
2 parents 7e3933d + 60aff17 commit 9bafa91
Show file tree
Hide file tree
Showing 17 changed files with 23 additions and 23 deletions.
2 changes: 1 addition & 1 deletion docs/examples/builds/balloon-block-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The balloon block editor type lets you create your content directly in its targe
* A {@link getting-started/setup/toolbar#block-toolbar block toolbar} accessible using the toolbar handle button {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} attached to the editable content area and following the selection in the document (bringing additional block formatting tools). The {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg Drag indicator} button is also a handle that can be used to drag and drop blocks around the content.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon-block) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon-block) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/balloon-block-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/balloon-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ classes: main__content--no-toc
The balloon editor type lets you create your content directly in its target location with the help of a balloon toolbar that appears next to the selected editable document element.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-balloon) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/balloon-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/classic-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ classes: main__content--no-toc
The classic editor type shows a boxed editing area with a toolbar, placed in a specific position on the page.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-classic) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-classic) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/classic-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/document-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The editor in this example is a feature–rich preset focused on rich text editi
See the {@link framework/document-editor tutorial} to learn how to create this kind of an editor (and similar) with a custom UI layout on top of {@link module:editor-decoupled/decouplededitor~DecoupledEditor}.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-document) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-document) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/document-editor}
2 changes: 1 addition & 1 deletion docs/examples/builds/inline-editor.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The inline editor type lets you create your content directly in its target locat
In this example the {@link features/images-styles image styles} configuration was changed to enable left- and right-aligned images.

<info-box hint>
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-inline) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
Check out the [source code](https://github.com/ckeditor/ckeditor5-demos/tree/master/user-interface-inline) of this editor preset or build your custom editor setup with our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

{@snippet examples/inline-editor}
4 changes: 2 additions & 2 deletions docs/features/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ Keep full control of your work. Be safe and never lose anything thanks to the {@

### Customizable user experience

Work as you like it &ndash; choose a user interface approach from several predefined layouts, add features to your preset or remove them with the [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs), or use the {@link getting-started/advanced/dll-builds DLL builds}. Then tailor the user interface to your needs with a customizable {@link getting-started/setup/toolbar editor toolbar}, arranging feature buttons, dropdowns, and other items in whatever way you need.
Work as you like it &ndash; choose a user interface approach from several predefined layouts, add features to your preset or remove them with the [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs), or use the {@link getting-started/advanced/dll-builds DLL builds}. Then tailor the user interface to your needs with a customizable {@link getting-started/setup/toolbar editor toolbar}, arranging feature buttons, dropdowns, and other items in whatever way you need.

{@img assets/img/full-toolbar.png 938 CKEditor&nbsp;5 customizable UI.}

Expand All @@ -126,7 +126,7 @@ If you want to migrate from CKEditor 4 to CKEditor&nbsp;5, check the {@link upda
We present each rich-text editor feature on a separate page. It includes one or more working demos showcasing a feature along with some customization ideas that you can use in your implementation.

<info-box>
**In most feature demos the number of features enabled is limited** to make the exposed piece of functionality stand out more, as shown in the screenshots above. But in your CKEditor&nbsp;5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available. You can achieve this by using the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
**In most feature demos the number of features enabled is limited** to make the exposed piece of functionality stand out more, as shown in the screenshots above. But in your CKEditor&nbsp;5 WYSIWYG editor implementation you are free to choose and combine any features you like from those available. You can achieve this by using the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>

## Why does the editor filter out content (styles, classes, elements)
Expand Down
2 changes: 1 addition & 1 deletion docs/framework/contributing/package-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ modified_at: 2021-06-07

The package metadata is a set of CKEditor&nbsp;5-related data describing plugins that the package delivers. It allows for the automated detection of plugins and building them by an external builder.

In the case of official CKEditor&nbsp;5 packages (as well as some partner ones), this data is used by the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) and allows for building the {@link framework/architecture/plugins#plugins-and-html-output Features' HTML output} page presenting a list of all official CKEditor&nbsp;5 plugins.
In the case of official CKEditor&nbsp;5 packages (as well as some partner ones), this data is used by the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) and allows for building the {@link framework/architecture/plugins#plugins-and-html-output Features' HTML output} page presenting a list of all official CKEditor&nbsp;5 plugins.

The package metadata should be saved in the special `ckeditor5-metadata.json` file in the root of the package published on npm.

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ You have a few methods to choose from:

## Using CKEditor&nbsp;5 Builder

Check out our [interactive Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) to quickly get a taste of CKEditor&nbsp;5. It offers an easy-to-use user interface to help you configure, preview, and download the editor suited to your needs. You can easily select:
Check out our [interactive Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to quickly get a taste of CKEditor&nbsp;5. It offers an easy-to-use user interface to help you configure, preview, and download the editor suited to your needs. You can easily select:

* editor type,
* the features you need,
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/setup/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ modified_at: 2024-06-25
The functionality of CKEditor&nbsp;5 is provided by specialized features, accessible via a configurable toolbar or keyboard shortcuts. Some of these features are only available with certain {@link getting-started/setup/editor-types editor types}.

<info-box>
The best tool for experimenting with different features is [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs). You can test various possibilities and setups.
The best tool for experimenting with different features is [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs). You can test various possibilities and setups.

Additionally, almost all features offer multiple configuration options and APIs. For detailed information, consult the {@link features/index feature pages}.
</info-box>
Expand All @@ -36,7 +36,7 @@ ClassicEditor
.catch( /* ... */ );
```

Note that some features may require more than one plugin to run, as shown above. This granular approach lets the integrators adjust available features to their specific needs. It is done during the setup and [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) is the easiest way to choose all needed features.
Note that some features may require more than one plugin to run, as shown above. This granular approach lets the integrators adjust available features to their specific needs. It is done during the setup and [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) is the easiest way to choose all needed features.

### Adding premium features

Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started/setup/editor-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ modified_at: 2024-06-25
The editor's user interface is dependent on the editor types. The editor provides functionality through specialized features accessible via a configurable toolbar or keyboard shortcuts. Some of these features are only available with certain editor types.

<info-box>
If you are unsure which editor type to choose, try the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs). It lets you quickly view and experiment with different presets.
If you are unsure which editor type to choose, try the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs). It lets you quickly view and experiment with different presets.
</info-box>

There are six ready-made editor types (see below) available for CKEditor&nbsp;5. They offer different functional approaches to editing as well as various UI solutions. Editor types are imported from the main `ckeditor5` package, the same way features are imported, as shown in the {@link getting-started/quick-start Quick start} guide.
Expand Down Expand Up @@ -83,5 +83,5 @@ The multi-root editor is an editor type that features multiple, separate editabl
See an {@link examples/builds/multi-root-editor example of the multi-root editor} in action.

<info-box>
At this time, the multi-root editor is not yet available via the [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
At this time, the multi-root editor is not yet available via the [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
</info-box>
2 changes: 1 addition & 1 deletion docs/getting-started/setup/license-key-and-activation.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,6 @@ ClassicEditor
.catch( /* ... */ );
```

To use premium features, you need to add the relevant plugins to your CKEditor&nbsp;5. You can use the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) to generate a CKEditor&nbsp;5 preset with the plugins enabled.
To use premium features, you need to add the relevant plugins to your CKEditor&nbsp;5. You can use the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to generate a CKEditor&nbsp;5 preset with the plugins enabled.

Alternatively, refer to the installation sections in the plugin documentation to do it on your own. You can read more about {@link getting-started/setup/configuration installing plugins} and {@link getting-started/setup/toolbar toolbar configuration} in dedicated guides.
4 changes: 2 additions & 2 deletions docs/getting-started/setup/toolbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Below is a sample toolbar with a basic set of features. Toolbar items can be eas
Toolbar configuration is a strict UI-related setting. Removing a toolbar item does not remove the feature from the editor internals. If your goal with the toolbar configuration is to remove features, the right solution is to also remove their respective plugins. Check the {@link getting-started/setup/configuration#removing-features removing features} guide for more information.
</info-box>

The toolbar offers a flexible arrangement, achieved through configuration. Please note, that using [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) makes this task significantly easier.
The toolbar offers a flexible arrangement, achieved through configuration. Please note, that using [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) makes this task significantly easier.

The following example may give you a general idea:

Expand Down Expand Up @@ -340,7 +340,7 @@ To access the block toolbar, you need to click the button with braille pattern d

The icon {@icon @ckeditor/ckeditor5-core/theme/icons/drag-indicator.svg drag indicator} is also a handle to drag blocks of content around the editor. Click a heading in the demo above and drag it all the way down between the following paragraphs to see this functionality in action.

The block toolbar complements the <!-- update to builder preset when ready-->[balloon editor type](https://ckeditor.com/ckeditor-5/builder?redirect=docs) where it falls short, for example when you must insert some content (like an image), but the selection is collapsed, so you cannot access the toolbar. It can, however, be added to any type of editor and configure accordingly (see below).
The block toolbar complements the <!-- update to builder preset when ready-->[balloon editor type](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) where it falls short, for example when you must insert some content (like an image), but the selection is collapsed, so you cannot access the toolbar. It can, however, be added to any type of editor and configure accordingly (see below).

See the <!-- update to builder preset when ready-->{@link examples/builds/balloon-block-editor balloon block editor example} page, too.

Expand Down
2 changes: 1 addition & 1 deletion docs/updating/maintaining.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ CKEditor&nbsp;5 should be {@link updating/updating-ckeditor-5 updated frequently

### Use Builder to add plugins

Some releases would bring new features and new plugins and sometimes replace old ones and make them obsolete. If you want to install additional plugins, it is easier and safer to use the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) instead of adding them manually. This will reduce the risk of omitting plugin dependencies.
Some releases would bring new features and new plugins and sometimes replace old ones and make them obsolete. If you want to install additional plugins, it is easier and safer to use the [CKEditor&nbsp;5 Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) instead of adding them manually. This will reduce the risk of omitting plugin dependencies.

## Safety

Expand Down
2 changes: 1 addition & 1 deletion docs/updating/migration-from-ckeditor-4.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ You can approach moving from CKEditor 4 to CKEditor&nbsp;5 as follows:

1. **Back up all your data.**
2. Learn about CKEditor&nbsp;5. Check the [demos](https://ckeditor.com/ckeditor-5/demo/), read about its {@link framework/architecture/intro architecture}, and review the {@link features/index available features} and {@link getting-started/index integration methods}.
3. Create a custom preset containing all the plugins you need the [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs).
3. Create a custom preset containing all the plugins you need the [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs).
4. Test loading pre-existing content created in CKEditor 4 into CKEditor&nbsp;5. Adjust the editor configuration and plugin set. If needed, enable the missing elements, classes, or attributes via the {@link features/general-html-support General HTML Support} feature.
5. When you are sure no data loss will occur, you can focus on customizing your CKEditor&nbsp;5 preset even more by changing the integration method, creating custom plugins, adjusting the theme, and enabling new features.

Expand Down
4 changes: 2 additions & 2 deletions docs/updating/nim-migration/online-builder.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@ If you do not want a build process, you can either use our CDN build or download

## CDN build

The CDN build is a good option to quickly add CKEditor&nbsp;5 to your website without installing any dependencies or setting up a build process. We recommend using our new interactive [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) to customize the build to your needs. Then, in the `Installation` section of the Builder, you can select the `Cloud (CDN)` option to learn how to add the editor to your website.
The CDN build is a good option to quickly add CKEditor&nbsp;5 to your website without installing any dependencies or setting up a build process. We recommend using our new interactive [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to customize the build to your needs. Then, in the `Installation` section of the Builder, you can select the `Cloud (CDN)` option to learn how to add the editor to your website.

## ZIP archive

If you do not want to have a build process or use our CDN build, you can download the ZIP archive from the [CKEditor&nbsp;5 download page](https://ckeditor.com/ckeditor-5/download/#zip). This archive contains the editor build with all its plugins, which you can extract and include on your website.

## npm package

If you decide to use the npm package, you can either use our new interactive [Builder](https://ckeditor.com/ckeditor-5/builder?redirect=docs) to create a new build, or you can update your existing project from the legacy Online Builder. **We recommend using the new interactive Builder**, but if you want to keep your existing build, you can follow the steps below.
If you decide to use the npm package, you can either use our new interactive [Builder](https://ckeditor.com/ckeditor-5/builder/?redirect=docs) to create a new build, or you can update your existing project from the legacy Online Builder. **We recommend using the new interactive Builder**, but if you want to keep your existing build, you can follow the steps below.

1. Follow the steps in the {@link updating/nim-migration/customized-builds Migrating from customized builds} guide.

Expand Down
Loading

0 comments on commit 9bafa91

Please sign in to comment.