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

Allow markdown ```example to render interactive example. #151

Merged
merged 3 commits into from
Jun 15, 2016
Merged

Allow markdown ```example to render interactive example. #151

merged 3 commits into from
Jun 15, 2016

Conversation

uipoet
Copy link
Contributor

@uipoet uipoet commented Jun 14, 2016

Markdown fenced code blocks without a syntax prevent text editors from enabling syntax features within the code block.

This change allows fenced code blocks with jsx syntax to render the same as without a syntax specified.

Markdown fenced code blocks without a syntax prevent text editors from enabling syntax features within the code block.

This change allows fenced code blocks with `jsx` syntax to render the same as without a syntax specified.
@mik01aj
Copy link
Collaborator

mik01aj commented Jun 15, 2016

If you change this, then you should update the docs too. See: https://github.com/sapegin/react-styleguidist/search?utf8=%E2%9C%93&q=fenced

@sapegin
Copy link
Member

sapegin commented Jun 15, 2016

Then how would we make a JSX code example that shouldn’t be rendered as a playground?

@uipoet
Copy link
Contributor Author

uipoet commented Jun 15, 2016

@mik01aj Thanks, I will update relevant docs.

@sapegin How about a unique fence type that won't conflict? We can configure our editors to treat any fence type as an alias to a valid one. I suggest example or playground.

`jsx` is an existing syntax. Use `example` to allow mixing interactive examples with `jsx` syntax highlighting.
@uipoet uipoet changed the title Allow markdown fence jsx to render example. Allow markdown ```example to render interactive example. Jun 15, 2016
@sapegin
Copy link
Member

sapegin commented Jun 15, 2016

example is fine, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants