Skip to content

Commit

Permalink
Merge pull request #9473 from ckeditor/i/9400
Browse files Browse the repository at this point in the history
Internal: Add plugins metadata. Closes #9400. Closes #9401.
  • Loading branch information
ma2ciek authored Apr 16, 2021
2 parents 4a663d7 + 1e6ed27 commit 946ea1c
Show file tree
Hide file tree
Showing 36 changed files with 1,533 additions and 0 deletions.
11 changes: 11 additions & 0 deletions packages/ckeditor5-adapter-ckfinder/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"plugins": [
{
"name": "CKFinder Upload Adapter",
"className": "CKFinderUploadAdapter",
"path": "src/uploadadapter.js",
"description": "This package implements a CKEditor 5 upload adapter compatible with the CKFinder file manager and uploader's server–side connector.",
"docs": "features/image-upload/image-upload.html#ckfinder"
}
]
}
30 changes: 30 additions & 0 deletions packages/ckeditor5-alignment/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{
"plugins": [
{
"name": "Alignment",
"className": "Alignment",
"path": "src/alignment.js",
"description": "Enables support for text alignment. You can use it to align your content to left, right and center or to justify it.",
"docs": "features/image-upload/image-upload.html#ckfinder",
"uiComponents": [
{
"type": "SplitButton",
"name": "alignment",
"pathToIcon": "TODO"
}
],
"htmlOutput": [
{
"elements": "$block",
"styles": "text-align",
"_comment": "By default, the alignment is set inline using `text-align` CSS property."
},
{
"elements": "$block",
"classes": "*",
"_comment": "If class names are defined in `config.alignment.options`, then these classes are used for alignment instead of inline styles."
}
]
}
]
}
11 changes: 11 additions & 0 deletions packages/ckeditor5-autoformat/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"plugins": [
{
"name": "Autoformat",
"className": "Autoformat",
"description": "Enables a set of predefined autoformatting actions. It allows for formatting text by typing sequences like **bold this**.",
"docs": "features/autoformat.html",
"path": "src/autoformat.js"
}
]
}
11 changes: 11 additions & 0 deletions packages/ckeditor5-autosave/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"plugins": [
{
"name": "Autosave",
"className": "Autosave",
"description": "Allows you to automatically save the data (e.g. send it to the server) when needed, for example, when the user changed the content.",
"docs": "builds/guides/integration/saving-data.html#autosave-feature",
"path": "src/autosave.js"
}
]
}
138 changes: 138 additions & 0 deletions packages/ckeditor5-basic-styles/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
{
"plugins": [
{
"name": "Bold",
"className": "Bold",
"description": "Implements bold formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/bold.js",
"uiComponents": [
{
"type": "Button",
"name": "bold",
"iconPath": "theme/icons/bold.svg"
}
],
"htmlOutput": [
{
"elements": "strong"
}
]
},
{
"name": "Code",
"className": "Code",
"description": "Implements inline code formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/code.js",
"uiComponents": [
{
"type": "Button",
"name": "code",
"iconPath": "theme/icons/code.svg"
}
],
"htmlOutput": [
{
"elements": "code",
"classes": "ck-code_selected"
}
]
},
{
"name": "Italic",
"className": "Italic",
"description": "Implements italic formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/italic.js",
"uiComponents": [
{
"type": "Button",
"name": "italic",
"iconPath": "theme/icons/italic.svg"
}
],
"htmlOutput": [
{
"elements": "i"
}
]
},
{
"name": "Strikethrough",
"className": "Strikethrough",
"description": "Implements strikethrough formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/strikethrough.js",
"uiComponents": [
{
"type": "Button",
"name": "strikethrough",
"iconPath": "theme/icons/strikethrough.svg"
}
],
"htmlOutput": [
{
"elements": "s"
}
]
},
{
"name": "Subscript",
"className": "Subscript",
"description": "Implements subscript formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/subscript.js",
"uiComponents": [
{
"type": "Button",
"name": "subscript",
"iconPath": "theme/icons/subscript.svg"
}
],
"htmlOutput": [
{
"elements": "sub"
}
]
},
{
"name": "Superscript",
"className": "Superscript",
"description": "Implements superscript formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/superscript.js",
"uiComponents": [
{
"type": "Button",
"name": "superscript",
"iconPath": "theme/icons/superscript.svg"
}
],
"htmlOutput": [
{
"elements": "sup"
}
]
},
{
"name": "Underline",
"className": "Underline",
"description": "Implements underline formatting support. It is a part of the basic text styles package.",
"docs": "features/basic-styles.html",
"path": "src/underline.js",
"uiComponents": [
{
"type": "Button",
"name": "underline",
"iconPath": "theme/icons/underline.svg"
}
],
"htmlOutput": [
{
"elements": "u"
}
]
}
]
}
22 changes: 22 additions & 0 deletions packages/ckeditor5-block-quote/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"plugins": [
{
"name": "BlockQuote",
"description": "Implements block quote support to easily include quotations and passages in the rich-text content.",
"docs": "features/block-quote.html",
"path": "src/blockquote.js",
"uiComponents": [
{
"type": "Button",
"name": "blockQuote",
"iconPath": "@ckeditor/ckeditor5-core/theme/icons/quote.svg"
}
],
"htmlOutput": [
{
"elements": "blockquote"
}
]
}
]
}
23 changes: 23 additions & 0 deletions packages/ckeditor5-ckfinder/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"plugins": [
{
"name": "CKFinder",
"pluginName": "CKFinder",
"description": "An image upload tool. It provides a full, server-side and client-side integration with CKFinder and all its features, including multiple file upload, image editor and file management.",
"docs": "features/image-upload/ckfinder.html",
"path": "src/ckfinder.js",
"requires": [
"CKFinderUploadAdapter",
"Link",
"Image"
],
"uiComponents": [
{
"name": "CKFinder",
"type": "Button",
"iconPath": "theme/icons/browser-files.svg"
}
]
}
]
}
11 changes: 11 additions & 0 deletions packages/ckeditor5-cloud-services/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"plugins": [
{
"name": "Cloud Services",
"className": "CloudServices",
"description": "A set of tools to work with CKEditor 5 Cloud Services.",
"path": "src/cloudservices.js",
"docs": "https://ckeditor.com/ckeditor-cloud-services"
}
]
}
31 changes: 31 additions & 0 deletions packages/ckeditor5-code-block/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
{
"plugins": [
{
"name": "Code blocks",
"className": "CodeBlock",
"description": "Allows for inserting and editing blocks of pre–formatted code with the programming language assigned.",
"docs": "features/code-blocks.html",
"path": "src/codeblock.js",
"uiComponents": [
{
"type": "Button",
"name": "codeBlock",
"iconPath": "theme/icons/codeblock.svg"
}
],
"htmlOutput": [
{
"elements": "pre"
},
{
"elements": "code",
"classes": [
"*",
"language-*"
],
"_comment": "By default, the language of the code block is represented as a CSS class prefixed by 'language-'. CSS class name can be customized via `config.codeBlock.languages` array."
}
]
}
]
}
16 changes: 16 additions & 0 deletions packages/ckeditor5-easy-image/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"plugins": [
{
"name": "Easy Image",
"className": "EasyImage",
"description": "An image upload tool with virtually zero server setup. The images are automatically rescaled, optimized, responsive and delivered through a CDN.",
"docs": "features/image-upload/easy-image.html",
"path": "src/easyimage.js",
"requires": [
"CloudServices",
"Image",
"ImageUpload"
]
}
]
}
27 changes: 27 additions & 0 deletions packages/ckeditor5-essentials/ckeditor5-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"plugins": [
{
"name": "Essentials",
"className": "Essentials",
"description": "Includes all essential editing features like clipboard, <kbd>Enter</kbd> and <kbd>Shift</kbd>+<kbd>Enter</kbd>, typing and undo support.",
"path": "src/essentials.js",
"uiComponents": [
{
"type": "Button",
"name": "undo",
"iconPath": "@ckeditor/ckeditor5-undo/theme/icons/undo.svg"
},
{
"type": "Button",
"name": "redo",
"iconPath": "@ckeditor/ckeditor5-undo/theme/icons/redo.svg"
}
],
"htmlOutput": [
{
"elements": "br"
}
]
}
]
}
Loading

0 comments on commit 946ea1c

Please sign in to comment.