-
-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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.
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
For each major plugin specify the HTML output and add it to the package matadata #9401
Comments
I would like to propose a slightly different output format, loosely modeled on MatcherPattern, where classes and styles are defined separately from other attributes. {
"plugin": "String",
"output": [
{
"elements": "String | Array.<String>",
"classes": "String | Array.<String>",
"styles": "String | Array.<String>",
"attributes": "String | Array.<String>",
"_comment": "String"
}
]
} Fields description:
Output for
|
👍👍👍 for underscoring this In general, the format looks interesting. I think we could try to go this way. Just some random thoughts:
|
The output format currently contains all possible classes, styles and attributes that the given plugin generates. I don't know if we want to go in the direction that we will additionally define classes, styles and attributes that are always present at the output? In the case of a plugin, that creates elements with dynamic classes (e.g. |
I had the same confusion at first.
I think we don't need to specify exact class names and styles, we could put only 'class' and 'style' to the Don't we need to put comments on the specific attributes? The table example seems to include the |
I think that if a specific attribute depends on a specific e.g. config option, then it could be listed in a separate item of the
I'd add to that one thing: how do we differentiate allowing an element and allowing an attribute of an element. Example: Table vs TableProperties features. Both should be documented separately. |
Makes sense.
This is a declaration of possible output so I'm not sure if we need to differentiate it |
Also we need some way to indicate that some element is a |
Paragraph:
Alignment:
Table:
TableProperties:
|
HTML outputs have been pushed to the main plugin metadata branch:
|
Closed by #9473. |
Extracted from #6642.
Scope
Notes
Before documenting every plugin output, let's do it for a few to check if the proposal works.
Current proposal:
The text was updated successfully, but these errors were encountered: