Docz: Remove <Playground> from output in the Playground

Created on 12 Jun 2018  路  5Comments  路  Source: doczjs/docz

When using <Playground> docz renders the <Playground> component as well as the component markup. Can it be removed?

Make this:

<Playground>
  <MyComponent />
</Playground>

Like this:

<MyComponent />

Most helpful comment

馃帀  Fixed and released in the new v0.4.0

All 5 comments

Yeah, this is better I think too. I tried to do this, but unfortunately did not work very well, so how I needed to release soon I ended up leaving for later! But I have plans to fix this, thanks @mrmartineau :pray:

Maybe remove <Playground> and </Playground> in here https://github.com/pedronauck/docz/blob/master/packages/docz-core/src/utils/plugin-hast.ts#L24 馃 Maybe there's a cleaner way?

This would also be nice when you need to prepare your props data in the documentation. For instance:

UserProfile.mdx:

import Username from './Username'
import { makeAvatarFromImage } from './utils'
import { userStub, imageStub } from './stubs'

## Usage

<Playground render={() => {
  const username = `@${userStub.username}`
  const avatar = makeAvatarFromImage(imageStub)

  // ... more lines of code that don't need to be displayed in the docs...

  return <UserProfile username={username} avatar={avatar} /> 
}} />

Output:

<UserProfile username={username} avatar={avatar} /> 

A related but different question: Is it possible to use javascript in MDX and make it available to the playground component?

For example:

import Username from './Username'
import { makeAvatarFromImage } from './utils'
import { userStub, imageStub } from './stubs'

const username = `@${userStub.username}`
const avatar = makeAvatarFromImage(imageStub)

// ... more lines of code that don't need to be displayed in the docs...

## Usage

<Playground>
   <UserProfile username={username} avatar={avatar} /> 
</Playground>

When I try something like this, i get username is not defined

To facilitate user feedbacks and make a really good roadmap, now we're using Canny as a tool to create our roadmap 馃槏

We think that is better keep Github issues only for bugs and other issues! 馃悶
This issue is already on our roadmap, so I'll close this issue in favor of it!

馃憠馃徎 Check this issue on roadmap

馃帀  Fixed and released in the new v0.4.0

Was this page helpful?
0 / 5 - 0 ratings

Related issues

fenbka picture fenbka  路  3Comments

brunolemos picture brunolemos  路  3Comments

mquandalle picture mquandalle  路  3Comments

wldcordeiro picture wldcordeiro  路  3Comments

bichotll picture bichotll  路  3Comments