Giter VIP home page Giter VIP logo

embed-play-into-docs's Introduction

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

embed-play-into-docs's People

Contributors

jugshaurya avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.