stevoland/react-bootstrap — pull request #11 by pieterv (2014-01-26 07:46:43+00:00)
Title: Docs example [RFC]

This is a possible approach for creating a documentation site for this project to address issue #7.

To see the docs site just pull down the code and open `docs/index.html` in a browser.

![Example docs](https://f.cloud.github.com/assets/438482/2003521/fadc5c78-865b-11e3-8d03-205b3f90a04f.png)

It really doesn't have much at the moment but I have copied layout/base html from the latest code in the bootstrap repo, and dropped in the latest bootstrap css. It looks very good although probably too similar to the bootstrap docs site and it may be nicer if we tweaked the colours to be more similar to the React site.

The site is currently all rendered with React as a single page app, this allows for the use of react-bootstrap components throughout the docs site which along with the examples serves as some pretty good functional tests for the project.

For the code examples, which i feel like are the most important part of the docs, i have grabbed the [ReactPlayground code](https://github.com/facebook/react/blob/master/docs/_js/live_editor.js) from the React site and integrated it with the bootstrap styles. The result is you can see the examples like they display on the bootstrap site but you can edit them and see updates in real time like the React site! It seems to be working quite well although it needs some code highlighting and possibly we need to hide the code section by default.

Let me know your thoughts, and what things you would like to see for this. I saw in issue #5 you were thinking of using generated API docs, if there was minimal overhead would you be open to the above approach?