Add better documentation/example website about react-mdl HOT 11 CLOSED

I would like to contribute to this in any way possible.

Suggestions:

• Kitchen sink.
• Maybe multiple codepen with use cases.

from react-mdl.

By using it, you already contribute because you might encounter some issues or have new suggestions to improve the library so thanks for that ;)

About the doc, I was thinking of something quite similar to the official doc, (based on this page http://www.getmdl.io/components/index.html) to list the components, show examples with code.

I'd built it based on react-mdl so at the same time it's a good example.

from react-mdl.

I see you have started the docs in a branch, can you create a roadmap maybe ?

from react-mdl.

Indeed I started a new branch while it's still in progress. Every day I try to convert the demos into the newly doc website ;)

from react-mdl.

Forgive my ignorance, but how can you have access to the docs ?

I looked into the docs fork, but the index.html file in the docs folder leads to nothing...

from react-mdl.

There's aa build step to create everything. I changed ab bit the structure recently and all the docs are now written in markdown. See this https://github.com/tleunen/react-mdl/tree/docs/docs/pages

from react-mdl.

The new docs have proven helpful already, thanks. There's one mistake, on the cards page cards have the following property: shadowLevel={0}, from the source code it seems like shadow is the correct property or is this a new api?

from react-mdl.

Good point. The new prop is shadow yes. It has been renamed in the v1.

from react-mdl.

Thanks @tleunen ! Much appreciated.

Wouldn't it make sense now to move everything to the github wiki of this repo, and get rid of the docs fork ?

from react-mdl.

It will be deployed on the github page to create the React MDL documentation website. It should be done over the weekend now ;)

from react-mdl.

Here it is, in its first version :) http://tleunen.github.io/react-mdl/

from react-mdl.