From b71ae596a87aaa0df3f473ab048b09b563c6fced Mon Sep 17 00:00:00 2001 From: Brent Jackson Date: Sat, 23 Jun 2018 18:37:55 -0400 Subject: [PATCH] Clean up docs --- README.md | 17 +++++++---------- docs/_app.js | 8 ++++++-- docs/_layout.js | 6 ++---- docs/{theme.js => _theme.js} | 0 docs/beep.jsx | 8 -------- docs/components.md | 19 ------------------- docs/{home.js => index.js} | 2 ++ docs/library/Button.md | 6 ------ docs/library/Donut.js | 5 ----- docs/library/Heading.md | 3 --- docs/library/index.js | 1 - docs/library/nested/hello.md | 5 ----- docs/library/nested/index.md | 4 ---- package.json | 6 +++--- 14 files changed, 20 insertions(+), 70 deletions(-) rename docs/{theme.js => _theme.js} (100%) delete mode 100644 docs/beep.jsx delete mode 100644 docs/components.md rename docs/{home.js => index.js} (98%) delete mode 100644 docs/library/Button.md delete mode 100644 docs/library/Donut.js delete mode 100644 docs/library/Heading.md delete mode 100644 docs/library/index.js delete mode 100644 docs/library/nested/hello.md delete mode 100644 docs/library/nested/index.md diff --git a/README.md b/README.md index a936c11..bbf1e21 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # x0 -Zero-config React development environment and static site generator +Document & develop React components without breaking a sweat [![Build Status][build-badge]][build] @@ -17,19 +17,16 @@ npm install -g @compositor/x0 ## Features - Zero-config -- Hot-loading development environment -- Works with virtually any React component\* -- No confusing APIs +- No plugins +- Components over configuration +- Use markdown, MDX, or React components - Automatic file system based routing -- Exports static HTML -- Exports JS bundles -- Works with CSS-in-JS libraries like [styled-components][sc] and [emotion][emotion] -- Support for async data fetching +- Completely customizable +- Export static sites +- Works as an isolated development environment Read more about x0 in our [blog post](https://compositor.io/blog/x0-making-react-component-development-stupid-simple/). -\* Custom [webpack configuration](#webpack) is required for components that rely on webpack-based features - ## Isolated development environment diff --git a/docs/_app.js b/docs/_app.js index ae06d95..478845d 100644 --- a/docs/_app.js +++ b/docs/_app.js @@ -3,16 +3,18 @@ import * as scope from 'rebass' import { Link } from 'react-router-dom' import { ScopeProvider, SidebarLayout } from '../components' import { + Provider as RebassProvider, Flex, Box, Container, } from 'rebass' import LandingLayout from './_layout' +import theme from './_theme' export default class App extends React.Component { static defaultProps = { - title: 'Hello' + title: 'x0' } render () { @@ -29,7 +31,9 @@ export default class App extends React.Component { return ( - + + + ) } diff --git a/docs/_layout.js b/docs/_layout.js index 0ea326f..9301e5e 100644 --- a/docs/_layout.js +++ b/docs/_layout.js @@ -1,6 +1,5 @@ import React from 'react' import { - Provider, Flex, Box, Container, @@ -10,10 +9,9 @@ import { } from 'rebass' import { Link } from 'react-router-dom' import { Logo } from '@compositor/logo' -import theme from './theme' export default ({ children }) => - + @@ -55,4 +53,4 @@ export default ({ children }) => - + diff --git a/docs/theme.js b/docs/_theme.js similarity index 100% rename from docs/theme.js rename to docs/_theme.js diff --git a/docs/beep.jsx b/docs/beep.jsx deleted file mode 100644 index fde25c8..0000000 --- a/docs/beep.jsx +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Beep JSX ---- -import { Box, Heading } from 'rebass' - - - Beep JSX - diff --git a/docs/components.md b/docs/components.md deleted file mode 100644 index 9681060..0000000 --- a/docs/components.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Components ---- -import { Box } from 'rebass' - -# Components - -This is a standard markdown file. - -This is a live/editable code block: - -```.jsx -Hello -``` - ---- - -fm title: {frontMatter.title} - diff --git a/docs/home.js b/docs/index.js similarity index 98% rename from docs/home.js rename to docs/index.js index abf09eb..0290f41 100644 --- a/docs/home.js +++ b/docs/index.js @@ -58,6 +58,7 @@ export default class extends React.Component { GitHub + {/* + */} diff --git a/docs/library/Button.md b/docs/library/Button.md deleted file mode 100644 index 1a19a8f..0000000 --- a/docs/library/Button.md +++ /dev/null @@ -1,6 +0,0 @@ - -# Button - -```.jsx - -``` diff --git a/docs/library/Donut.js b/docs/library/Donut.js deleted file mode 100644 index b37cd0a..0000000 --- a/docs/library/Donut.js +++ /dev/null @@ -1,5 +0,0 @@ -import React from 'react' -import { Donut } from 'rebass' - -export default () => - diff --git a/docs/library/Heading.md b/docs/library/Heading.md deleted file mode 100644 index 788b0f5..0000000 --- a/docs/library/Heading.md +++ /dev/null @@ -1,3 +0,0 @@ -```!jsx -Hello -``` diff --git a/docs/library/index.js b/docs/library/index.js deleted file mode 100644 index 19fcd81..0000000 --- a/docs/library/index.js +++ /dev/null @@ -1 +0,0 @@ -export { Library as default } from '../../components' diff --git a/docs/library/nested/hello.md b/docs/library/nested/hello.md deleted file mode 100644 index a6f72fb..0000000 --- a/docs/library/nested/hello.md +++ /dev/null @@ -1,5 +0,0 @@ - - -# hello - -`/examples/nested/hello.md` diff --git a/docs/library/nested/index.md b/docs/library/nested/index.md deleted file mode 100644 index 06ec06e..0000000 --- a/docs/library/nested/index.md +++ /dev/null @@ -1,4 +0,0 @@ - -# Nested - -`/examples/nested/index.md` diff --git a/package.json b/package.json index 7aa01dd..df4460e 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@compositor/x0", "version": "6.0.0-4", - "description": "Zero-config React development environment and static site generator", + "description": "Document & develop React components without breaking a sweat", "main": "index.js", "bin": { "x0": "cli.js" @@ -93,12 +93,12 @@ "sinon": "^6.0.0" }, "x0": { - "title": "Compositor x0", + "title": "x0", "basename": "/x0", "meta": [ { "name": "description", - "content": "Zero-config React development environment and static site generator" + "content": "Document & develop React components without breaking a sweat" }, { "name": "twitter:card",