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

[BREAKING] Rename Marked to MarkdownBlock #162

Merged
merged 15 commits into from
Oct 30, 2017
Merged

[BREAKING] Rename Marked to MarkdownBlock #162

merged 15 commits into from
Oct 30, 2017

Conversation

hramos
Copy link
Contributor

@hramos hramos commented Oct 24, 2017

This is a breaking change that renames the Marked component, which is exposed to clients via CompLibrary, to MarkdownBlock. This moves us away from exposing internal implementation details to clients, and gives us flexibility to change markdown parsing/rendering engines in the future.

This is built on top of the remarkable branch, therefore #153 should be merged first.

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 24, 2017
Copy link
Contributor

@JoelMarcey JoelMarcey left a comment

Choose a reason for hiding this comment

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

Can you rebase this after the merge of #153?

@hramos
Copy link
Contributor Author

hramos commented Oct 24, 2017

Rebased.

@hramos
Copy link
Contributor Author

hramos commented Oct 26, 2017

This is good to go. I think it's alright to use MarkdownBlock here, and down the line we can extend this component to use different renderers as a configurable option, if the need arises.

@hramos
Copy link
Contributor Author

hramos commented Oct 26, 2017

It's a small breaking change, so we can hold off on merging until we deploy a new package.

@@ -239,7 +239,7 @@ function execute(port) {
if (metadata.layout && siteConfig.layouts[metadata.layout]) {
Doc = siteConfig.layouts[metadata.layout]({
React,
Marked: require("../core/Marked.js")
MarkdownBlock: require("../core/MarkdownBlock.js")
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm the only one to use this, feel free to merge and i'll update my code. I have to work anyway to deal with the hljs migration.

Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we should export CompLibrary here instead?

@JoelMarcey JoelMarcey merged commit 09354ab into master Oct 30, 2017
@JoelMarcey JoelMarcey deleted the rename-marked branch October 30, 2017 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants