Skip to content

Commit

Permalink
Include example of readme for landing
Browse files Browse the repository at this point in the history
  • Loading branch information
soyjavi committed Nov 1, 2015
1 parent de967c4 commit 1e47f03
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 5 deletions.
7 changes: 5 additions & 2 deletions docs/app/components/layout/home/index.jsx
@@ -1,10 +1,13 @@
import React from 'react';
import { Card } from 'react-toolbox';
import style from './style';

import Logo from '../../logo';
import Navigation from '../../navigation';
import Markdown from '../../markdown';

import style from './style';
import authors from './modules/authors';
import readme from './modules/readme.md';

const Home = () => {
return (
Expand All @@ -16,7 +19,7 @@ const Home = () => {
<Navigation className={style.navigation} />
</header>
<section className={style.content}>
<h2>Authors</h2>
<Markdown className={style.documentation} markdown={readme}/>

<ul className={style.authors}>
{ authors.map((author, index) => { return <Card key={index} {...author} />; }) }
Expand Down
18 changes: 18 additions & 0 deletions docs/app/components/layout/home/modules/readme.md
@@ -0,0 +1,18 @@
# React Toolbox Components

React Toolbox is a library of React Components based on Google's Material Design Guidelines. The main purpose of the documentation is to explore each of the components and to learn how to use them. To make the best possible experience and to experiment with the components properties and methods, we've created a playground to try components live.

On the top right side of the screen you will see a rounded button with a code icon. It opens a the playground with a small in-browser editor and an area to render what you type in real time. Inside the documentation of each component you will see one or multiple example code boxes. Each of them can include a button to open the given code in the playground.

Enjoy and remember that [feedback](https://github.com/react-toolbox/react-toolbox/issues) is really appreciated.

# Lorem ipsum...

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

# Authors
8 changes: 5 additions & 3 deletions docs/app/components/layout/home/style.scss
Expand Up @@ -2,6 +2,7 @@
@import "./config";

$content-offset: 4.8 * $unit;
$content-width: 740px;

.hero {
padding: 0 calc((100% - #{$hero-max-width}) / 2);
Expand Down Expand Up @@ -67,10 +68,11 @@ $content-offset: 4.8 * $unit;
display: flex;
flex-direction: column;
align-items: center;
background-color: $color-content;
> * {
min-width: 700px;
max-width: 700px;
margin: ($content-offset / 4) auto;
min-width: $content-width;
max-width: $content-width;
margin: 0 ($content-offset / 4);
}
}

Expand Down

0 comments on commit 1e47f03

Please sign in to comment.