nteract / vdom

🎄 Virtual DOM for Python
https://github.com/nteract/vdom/blob/master/docs/mimetype-spec.md
BSD 3-Clause "New" or "Revised" License
221 stars 34 forks source link

Create example notebooks #4

Open rgbkrk opened 6 years ago

rgbkrk commented 6 years ago

Let's dogfood some documentation for vdom!

It can be similar to the vdom notebook in nteract desktop.

Getting started contributing example notebooks

  1. Install nteract follow instructions there for configuring your kernel
  2. Verify that your python kernel works inside nteract
  3. Install vdom, either by:
  4. Create a notebook using vdom, providing narrative text about what you're guiding the user towards
rgbkrk commented 6 years ago

Some ideas for notebooks --

Crafting tables from basic python arrays

screen shot 2017-10-05 at 7 04 55 am

Creating "custom components" for PyData Stack objects

screen shot 2017-10-05 at 7 10 16 am

Note: the design patterns doc explores this a bit and should be freely copied from