unified docs

zookatron · Dec 22, 2018 · 74cb9a1 · 74cb9a1
1 parent 6db27a9
commit 74cb9a1
Show file tree

Hide file tree

Showing 68 changed files with 2,788 additions and 332 deletions.
diff --git a/.storybook/preview-head.html b/.storybook/preview-head.html
diff --git a/.storybook/storybook.sass b/.storybook/storybook.sass
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 `rbx` is a comprehensive library of React components for [Bulma 0.7.2](http://bulma.io).
 
-🔥 **All components have exhaustive** [storybook examples](https://dfee.github.io/rbx).
+🔥 **[Read the docs](https://dfee.github.io/rbx/stories)**.
 
 🙃 _I'll wait, go check them out!_
 
@@ -50,76 +50,13 @@ export const goHomeLink = (
 );
 ```
 
-For styling, each component imports its own sass file.
-Thus, you can reduce your css total file size by only including the styles that you will use.
-To enable this, configure your [Webpack](https://webpack.github.io/) to handle sass files.
-
-While some components may slightly differ from the Bulma API, these changes are usually minimal.
-
-#### Base
-
-| Item    | Storybook                                                            | Bulma Documentation |
-| ------- | -------------------------------------------------------------------- | ------------------- |
-| Generic | [Stories](https://dfee.github.io/rbx/?selectedKind=Extras%2FGeneric) | N/A                 |
-
-#### Components
-
-| Item       | Storybook                                                                   | Bulma Documentation                                                    |
-| ---------- | --------------------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| Breadcrumb | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FBreadcrumb) | [Documentation](http://bulma.io/documentation/components/breadcrumb/)  |
-| Card       | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FCard)       | [Documentation](http://bulma.io/documentation/components/card/)        |
-| Dropdown   | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FDropdown)   | [Documentation](http://bulma.io/documentation/components/dropdown/)    |
-| Level      | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FLevel)      | [Documentation](http://bulma.io/documentation/layout/level/)           |
-| List       | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FList)       | [Documentation](http://bulma.io/documentation/components/list/)        |
-| Media      | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FMedia)      | [Documentation](http://bulma.io/documentation/layout/media-object/)    |
-| Menu       | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FMenu)       | [Documentation](http://bulma.io/documentation/components/menu/)        |
-| Message    | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FMessage)    | [Documentation](http://bulma.io/documentation/components/message/)     |
-| Modal      | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FModal)      | [Documentation](http://bulma.io/documentation/components/modal/)       |
-| Navbar     | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FNavbar)     | [Documentation](https://bulma.io/documentation/components/navbar/)     |
-| Pagination | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FPagination) | [Documentation](https://bulma.io/documentation/components/pagination/) |
-| Panel      | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FPanel)      | [Documentation](https://bulma.io/documentation/components/panel/)      |
-| Tabs       | [Stories](https://dfee.github.io/rbx/?selectedKind=Components%2FTabs)       | [Documentation](https://bulma.io/documentation/components/tabs/)       |
-
-#### Elements
-
-| Item         | Storybook                                                                   | Bulma Documentation                                                   |
-| ------------ | --------------------------------------------------------------------------- | --------------------------------------------------------------------- |
-| Box          | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FBox)          | [Documentation](http://bulma.io/documentation/elements/box/)          |
-| Button       | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FButton)       | [Documentation](http://bulma.io/documentation/elements/button/)       |
-| Container    | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FContainer)    | [Documentation](http://bulma.io/documentation/layout/container/)      |
-| Content      | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FContent)      | [Documentation](http://bulma.io/documentation/elements/content/)      |
-| Form         | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FForm)         | [Documentation](http://bulma.io/documentation/form/general/)          |
-| Icon         | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FIcon)         | [Documentation](http://bulma.io/documentation/elements/icon/)         |
-| Image        | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FImage)        | [Documentation](http://bulma.io/documentation/elements/image/)        |
-| Notification | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FNotification) | [Documentation](http://bulma.io/documentation/elements/notification/) |
-| Other        | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FOther)        | N/A                                                                   |
-| Progress     | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FProgress)     | [Documentation](http://bulma.io/documentation/elements/progress/)     |
-| Table        | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FTable)        | [Documentation](http://bulma.io/documentation/elements/table/)        |
-| Tag          | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FTag)          | [Documentation](http://bulma.io/documentation/elements/tag/)          |
-| Title        | [Stories](https://dfee.github.io/rbx/?selectedKind=Elements%2FTitle)        | [Documentation](http://bulma.io/documentation/elements/title/)        |
-
-#### Grid
-
-| Item    | Storybook                                                          | Bulma Documentation                                          |
-| ------- | ------------------------------------------------------------------ | ------------------------------------------------------------ |
-| Columns | [Stories](https://dfee.github.io/rbx/?selectedKind=Grid%2FColumns) | [Documentation](http://bulma.io/documentation/columns/)      |
-| Tiles   | [Stories](https://dfee.github.io/rbx/?selectedKind=Grid%2FTiles)   | [Documentation](http://bulma.io/documentation/layout/tiles/) |
-
-#### Layout
-
-| Item    | Storybook                                                            | Bulma Documentation                                            |
-| ------- | -------------------------------------------------------------------- | -------------------------------------------------------------- |
-| Footer  | [Stories](https://dfee.github.io/rbx/?selectedKind=Layout%2FFooter)  | [Documentation](http://bulma.io/documentation/layout/footer/)  |
-| Hero    | [Stories](https://dfee.github.io/rbx/?selectedKind=Layout%2FHero)    | [Documentation](http://bulma.io/documentation/layout/hero/)    |
-| Section | [Stories](https://dfee.github.io/rbx/?selectedKind=Layout%2FSection) | [Documentation](http://bulma.io/documentation/layout/section/) |
-
 ### Customize Bulma
 
 To override the variables set by Bulma, install Bulma (`npm install [email protected]`), and [follow the Bulma instructions](https://bulma.io/documentation/customize/variables/).
 
 You will also need to import `rbx/rbx.sass` as it contains any pertinent bug fixes for Bulma.
 
-A minimal example of `style.sass` might look like:
+A minimal example of `App.sass` might look like:
 
 ```sass
 $primary: #61dafb
@@ -128,7 +65,7 @@ $primary: #61dafb
 @import "../src/index.sass"
 ```
 
-Then, import this file into the root of your project.
+Then, import this file somewhere in your project.
 
 #### Create React App
 
@@ -143,3 +80,7 @@ Finally, import this stylesheet somewhere in your CRA app.
 ```js
 import "./App.sass";
 ```
+
+#### Prior Art
+
+This package was forked from [`react-bulma-components`](https://github.com/couds/react-bulma-components`), and re-written in its entirety to support the latest version of Bulma, use TypeScript, and fix many outstanding bugs.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,13 @@
+### Running
+
+`npm run docs:core:dev`
+`npm run docs:storybook:dev`
+
+### Build
+
+`npm run docs:core:build`
+`npm run docs:storybook:build`
+
+### Deploy
+
+`npm run docs:deploy`
diff --git a/docs/core/App.sass b/docs/core/App.sass
@@ -0,0 +1,4 @@
+$primary: #61dafb
+
+@import "~bulma/bulma.sass"
+@import "../../src/index.sass"