1.1.12 • Published 3 years ago

embed-play-into-docs v1.1.12

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

embed-play-into-docs

  • Using only two components here
    • Avatar Playground
    • Card playground

Imported from root lib/index.js file

import AvatarPlayground from "./content/Avatar/avatar.playground";
import CardPlayground from "./content/Card/card.playground";

export default {
  AvatarPlayground,
  CardPlayground,
};

Peek a boo!

Gif

This is the repo to mimic basic required functionality of playground

  • add content folder with two index and two respective playground file
  • add components folder with one component file
  • add containers folder as in playground
  • publish to npm

make Publishable

  • add prettier husky
  • add eslint - basic only
  • export all playgrounds from content/index.js = entry point of library.

    • write a script to import all the playgrounds from content directory and export them out automatically into lib folder(copy content.jsx to lib.jsx)

    • publish lib folder onto npm.

    • run yarn build
    • update version in package.json
    • npm publish
    • yarn upgrade embed-play-into-docs

Stretch

  • add test with jest and react-testing library
  • add eslint all features

mimic-elements-docs-docasaurus

  • mimic elements folder here
  • import published playgrounds here
  • create a button
  • create a modal
  • interpolate modal with playground