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

Implement react-otp-input within docz docmentation #227

Closed
wants to merge 1 commit into from

Conversation

nirmalhk7
Copy link
Contributor

  • What does this PR do?
    Fixed Implement component within docz's playground #210

  • Any background context you want to provide?
    I initially wanted to render the demo in the README.md file. If you copy-paste all content from demo.mdx into README.md, it works really well on the docz server, but that JSX is also printed directly (with no formatting) in markdown. Therefore we'd have had a great documentation website, but ugly JSX code in the repository's README. That's why I felt it'd be better if the demo is kept separately from the README.

If there's a way for JSX to be shown on docz but not on README, please let me know. I've searched online but I couldn't find any way for it.

  • Screenshots and/or Live Demo

Screenshot from 2020-10-08 12-17-47

@nirmalhk7
Copy link
Contributor Author

@apollonian Please review. Thanks!

Signed-off-by: Nirmal Khedkar <[email protected]>
@nirmalhk7
Copy link
Contributor Author

Please let me know if there are any changes to be done, thank you!

@@ -200,25 +200,3 @@ Feel free to open [issues](https://github.com/devfolioco/react-otp-input/issues/
## License

[![NPM](https://img.shields.io/npm/l/react-otp-input)](https://github.com/devfolioco/react-otp-input/blob/master/LICENSE)

## Contributors ✨
Copy link
Contributor

Choose a reason for hiding this comment

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

Does docz error out when we have this section in the README?

Base automatically changed from master to main January 20, 2021 15:14
@prateek3255
Copy link
Collaborator

Thanks for working on this @nirmalhk7 and sorry for the delayed response. We updated the file structure with v3 can you reopen the PR with the latest changes?

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

Successfully merging this pull request may close these issues.

Implement component within docz's playground
3 participants