Giter VIP home page Giter VIP logo

ribcage-docs's Introduction

ribcage-docs

Start a server to serve your component docs and live-reloading examples

Useage

cd {{project}}
node ../ribcage-docs/bin/cli.js components

ribcage-docs's People

Contributors

joeybaker avatar techwraith avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

ribcage-docs's Issues

Migrate example format

  • examples should have an example div
  • example js should append itself to that
  • ribcage-preview should pull the whole readme as default html
  • ribcage-docs should bundle all js and css examples

Run tests for each component

  • Find a way to run tests for each component
  • report their status in real time to the site
  • if all tests are passing, change the favicon to a green dot
  • if all tests are failing, change the favicon to a red dot

Implement component examples

Component examples should be able to be run from this route:

/:component/example
  • it should have live reload built in
  • many examples should be able to be run at once (not necessarily on the same page)
  • add an iframe below each component's readme with the example embedded.
  • add a button to the readme to open the example in a new tab

Make this thing look much prettier

Right now there is no CSS or even real html.

  • add some css to make the docs look better
  • perhaps make the whole thing a single page app
  • write a real template to put the site in

Implement sidebar

  • use /components.json
  • grey out components with no docs
  • put a red dot before components with failing or non-existent tests
  • put a green dot before components with passing tests
  • continuously run tests as code changes
  • link component name to component readme

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.