Skip to content
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

Add documentation describing block transforms #5189

Merged
merged 3 commits into from
Feb 23, 2018
Merged

Add documentation describing block transforms #5189

merged 3 commits into from
Feb 23, 2018

Conversation

travislopes
Copy link
Contributor

Here's a first pass on the documentation on defining block transforms. There's a couple transform types I haven't used before (regular expression, raw DOM node) that I could use some explanations for myself so I can add them to the docs.

content,
} );
},
},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we stop here in this example and leave the shortcode for another example (to match the text above)?


For example, a paragraph block can be transformed into a heading block.

```js
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we do an es5/esnext version like the other examples in the handbook?

@youknowriad
Copy link
Contributor

Thanks for this, left a minor comment but this is looking good for a start. I think we probably want to move these to a separate file at some point because there's a lot to say about transforms, but it's fine for now.

@Soean Soean added the [Type] Developer Documentation Documentation for developers label Feb 22, 2018
@leepeterson
Copy link

👍

Copy link
Contributor

@youknowriad youknowriad left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

@youknowriad youknowriad merged commit b896f55 into WordPress:master Feb 23, 2018
@travislopes travislopes deleted the update/documentation branch February 23, 2018 14:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants