Skip to content

DOC-3310: Fix uploadcare_resources option examples #3895

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MitchC1999 merged 2 commits into from
Nov 3, 2025
Merged

DOC-3310: Fix uploadcare_resources option examples #3895

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84b9484
DOC-3310: Fix `uploadcare_resources` option examples
MitchC1999 Oct 27, 2025
891a1ca
DOC-3310: Filenames are important too
MitchC1999 Oct 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 6 additions & 47 deletions modules/ROOT/partials/configuration/uploadcare_resources.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,11 @@
[[uploadcare-resources]]
== `uploadcare_resources`

Specifies the base path where the Uploadcare plugin resources are served from. This option is primarily used when bundling {productname} with webpack or other bundlers, where the plugin needs to know where to load additional resources such as the `ucvideo.min.js` file for video functionality.

When {productname} is bundled, the Uploadcare plugin cannot automatically determine where its additional resources are located. This option tells the plugin where to find these resources by specifying the root path to the Uploadcare plugin directory.
Specifies the base path where the Uploadcare plugin resources are loaded from. This allows you to specify a different location for the Uploadcare resources if they are hosted separately from the main {productname} installation.

*Type:* `+String+`

*Default:* `+undefined+`

*Possible values:* A string that points to the root path of the Uploadcare plugin directory.

[NOTE]
This option is only required when using the **Media Optimizer** as a paid "addon" and bundling {productname} with webpack or similar bundling tools.
*Default:* `+'<plugin-path>'+`

.Example: Setting `uploadcare_resources`
[source,js]
Expand All @@ -22,53 +15,19 @@ tinymce.init({
plugins: 'uploadcare',
toolbar: 'uploadcare uploadcare-video',
uploadcare_public_key: '<your-public-key>',
uploadcare_resources: 'uploadcare/uploadcare', // Points to the uploadcare plugin directory
uploadcare_resources: 'path/to/uploadcare-resources/',
Comment thread
MitchC1999 marked this conversation as resolved.
license_key: '<your-license-key>'
});
----

=== Complete Bundled Setup Example

For a complete example of setting up {productname} with the Uploadcare addon, see the bundled setup example:

[source,html]
----
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>TinyMCE with Uploadcare Addon</title>
<script src="path/to/tinymce/tinymce.min.js"></script> <!-- points to the tinymce.min.js file in your project -->
<script src="path/to/uploadcare/uploadcare/plugin.min.js"></script> <!-- points to the uploadcare plugin.min.js file in your project -->
</head>
<body>
<textarea>Welcome to TinyMCE with Uploadcare!</textarea>
<script>
tinymce.init({
selector: 'textarea',
plugins: [
"uploadcare"
],
toolbar: "uploadcare uploadcare-video",
uploadcare_resources: 'path/to/uploadcare/uploadcare', // points to the uploadcare plugin directory
uploadcare_public_key: '<your-public-key>',
license_key: '<your-license-key>'
});
</script>
</body>
</html>
----

=== Resource Structure
=== Resources Structure

When using `uploadcare_resources`, ensure your directory structure follows this pattern:
When using `uploadcare_resources`, ensure your directory structure follows this pattern, specifically the `js` and `css` subdirectories, and that the necessary resource files are present:

.Example directory structure:
[source,text]
----
project/
├── uploadcare/
│ └── uploadcare/
│ ├── js/
│ │ └── ucvideo.min.js
Expand All @@ -79,4 +38,4 @@ project/
└── tinymce.min.js
----

The plugin will automatically append the necessary subpaths (e.g., `/js/ucvideo.min.js`) to the base path you specify.
NOTE: This option does not control the loading of the main Uploadcare plugin script, which should be included in the `+plugins+` or `+external_plugins+` configuration options as appropriate.