Back to README style docs for now

aruprakshit · May 12, 2020 · a1f5d41 · a1f5d41
1 parent 656c047
commit a1f5d41
Show file tree

Hide file tree

Showing 31 changed files with 165 additions and 364 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,3 @@
----
-name: Changelog
-route: /changelog
----
-
 # React Table Changelog
 
 ## 7.0.4

diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,8 +1,3 @@
----
-name: Code of Conduct
-route: /code-of-conduct
----
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -19,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 Examples of behavior that contributes to creating a positive environment
 include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
- advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
- address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
- professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
 
 ## Our Responsibilities
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,8 +1,3 @@
----
-name: Contributing
-route: /contributing
----
-
 # Contributing
 
 ## Questions

diff --git a/README.md b/README.md
@@ -1,8 +1,3 @@
----
-name: Getting Started
-route: /
----
-
 ![React Table Header](https://github.com/tannerlinsley/react-table/raw/master/media/header.png)
 
 <img src='https://github.com/tannerlinsley/react-table/raw/master/media/logo.png' width='300'/>

diff --git a/docs/api/useAbsoluteLayout.md b/docs/api/useAbsoluteLayout.md
@@ -1,9 +1,3 @@
----
-name: useAbsoluteLayout
-route: /api/useAbsoluteLayout
-menu: API
----
-
 # `useAbsoluteLayout`
 
 - Plugin Hook

diff --git a/docs/api/useBlockLayout.md b/docs/api/useBlockLayout.md
@@ -1,9 +1,3 @@
----
-name: useBlockLayout
-route: /api/useBlockLayout
-menu: API
----
-
 # `useBlockLayout`
 
 - Plugin Hook

diff --git a/docs/api/useColumnOrder.md b/docs/api/useColumnOrder.md
@@ -1,9 +1,3 @@
----
-name: useColumnOrder
-route: /api/useColumnOrder
-menu: API
----
-
 # `useColumnOrder`
 
 - Plugin Hook

diff --git a/docs/api/useExpanded.md b/docs/api/useExpanded.md
@@ -1,9 +1,3 @@
----
-name: useExpanded
-route: /api/useExpanded
-menu: API
----
-
 # `useExpanded`
 
 - Plugin Hook

diff --git a/docs/api/useFilters.md b/docs/api/useFilters.md
@@ -1,9 +1,3 @@
----
-name: useFilters
-route: /api/useFilters
-menu: API
----
-
 # `useFilters`
 
 - Plugin Hook

diff --git a/docs/api/useFlexLayout.md b/docs/api/useFlexLayout.md
@@ -1,9 +1,3 @@
----
-name: useFlexLayout
-route: /api/useFlexLayout
-menu: API
----
-
 # `useFlexLayout`
 
 - Plugin Hook

diff --git a/docs/api/useGlobalFilter.md b/docs/api/useGlobalFilter.md
@@ -1,9 +1,3 @@
----
-name: useGlobalFilter
-route: /api/useGlobalFilter
-menu: API
----
-
 # `useGlobalFilter`
 
 - Plugin Hook

diff --git a/docs/api/useGroupBy.md b/docs/api/useGroupBy.md
@@ -1,9 +1,3 @@
----
-name: useGroupBy
-route: /api/useGroupBy
-menu: API
----
-
 # `useGroupBy`
 
 - Plugin Hook

diff --git a/docs/api/usePagination.md b/docs/api/usePagination.md
@@ -1,8 +1,3 @@
----
-name: usePagination
-route: /api/usePagination
-menu: API
----
 # `usePagination`
 
 - Plugin Hook

diff --git a/docs/api/useResizeColumns.md b/docs/api/useResizeColumns.md
@@ -1,9 +1,3 @@
----
-name: useResizeColumns
-route: /api/useResizeColumns
-menu: API
----
-
 # `useResizeColumns`
 
 - Plugin Hook

diff --git a/docs/api/useRowSelect.md b/docs/api/useRowSelect.md
@@ -1,9 +1,3 @@
----
-name: useRowSelect
-route: /api/useRowSelect
-menu: API
----
-
 # `useRowSelect`
 
 - Plugin Hook

diff --git a/docs/api/useRowState.md b/docs/api/useRowState.md
@@ -1,9 +1,3 @@
----
-name: useRowState
-route: /api/useRowState
-menu: API
----
-
 # `useRowState`
 
 - Plugin Hook

diff --git a/docs/api/useSortBy.md b/docs/api/useSortBy.md
@@ -1,9 +1,3 @@
----
-name: useSortBy
-route: /api/useSortBy
-menu: API
----
-
 # `useSortBy`
 
 - Plugin Hook

diff --git a/docs/api/useTable.md b/docs/api/useTable.md
@@ -1,9 +1,3 @@
----
-name: useTable
-route: /api/useTable
-menu: API
----
-
 # `useTable`
 
 - Required

diff --git a/docs/api/useTokenPagination.md b/docs/api/useTokenPagination.md
diff --git a/docs/concepts.md b/docs/concepts.md
@@ -1,8 +1,3 @@
----
-name: Concepts
-route: /concepts
----
-
 # Concepts
 
 ## React Table is a "headless" UI library
@@ -33,6 +28,7 @@ As of React Table v7, **you the developer** are responsible for rendering your o
 ---
 
 After reading about React Table's concepts, you should:
+
 - [Follow the Quick Start](./quickstart.mdx)
 - [Check Out Some Examples](./examples)
 - [Study the API](./api)
diff --git a/docs/examples.mdx → docs/examples.md b/docs/examples.mdx → docs/examples.md
@@ -1,8 +1,3 @@
----
-name: Examples
-route: /examples
----
-
 # Examples
 
 - [**Simple**](./examples/simple.mdx) - All of these examples use automatic state management, meaning, they don't hoist any state out of the table or manually control anything. Start here for understanding the basics about how to build your table UI.

diff --git a/docs/examples/complex.md b/docs/examples/complex.md
@@ -0,0 +1,12 @@
+# Complex
+
+These examples are more advanced because they demonstrate how to manually control and respond to the state of the table.
+
+## The "Kitchen Sink"
+
+This example includes Pagination, Sorting, Filtering, Grouping, Expandable Rows and Row Selection so it's called the _Kitchen Sink_.
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/kitchen-sink)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/kitchen-sink)
+
+* Want to add another example? [Submit a PR!](https://github.com/tannerlinsley/react-table/compare)
diff --git a/docs/examples/complex.mdx b/docs/examples/complex.mdx
diff --git a/docs/examples/controlled.md b/docs/examples/controlled.md
@@ -0,0 +1,10 @@
+# Controlled
+
+These examples are more advanced because they demonstrate how to manually control and respond to the state of the table.
+
+## Pagination (Controlled)
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/pagination-controlled)
+
+* Want to add another example? [Submit a PR!](https://github.com/tannerlinsley/react-table/compare)
diff --git a/docs/examples/controlled.mdx b/docs/examples/controlled.mdx
diff --git a/docs/examples/simple.mdx → docs/examples/simple.md b/docs/examples/simple.mdx → docs/examples/simple.md
@@ -1,9 +1,3 @@
----
-name: Simple
-route: /examples/simple
-menu: Examples
----
-
 # Simple
 
 All of these examples use automatic state management, meaning, they don't hoist any state out of the table or manually control anything. Start here for understanding the basics about how to build your table UI.
@@ -12,13 +6,6 @@ All of these examples use automatic state management, meaning, they don't hoist
 
 - [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/basic)
 - [Open in CodeSandbox](https://codesandbox.io/embed/github/tannerlinsley/react-table/tree/master/examples/basic)
-  <iframe
-    src="https://codesandbox.io/embed/github/tannerlinsley/react-table/tree/master/examples/basic?autoresize=1&fontsize=14&module=%2Fsrc%2FApp.js&theme=dark"
-    style="width:100%; height:500px; border:0; border-radius: 4px; overflow:hidden;"
-    title="tannerlinsley/react-table: basic"
-    allow="geolocation; microphone; camera; midi; vr; accelerometer; gyroscope; payment; ambient-light-sensor; encrypted-media; usb"
-    sandbox="allow-modals allow-forms allow-popups allow-scripts allow-same-origin"
-  ></iframe>
 
 ## Footers
 

diff --git a/docs/examples/ui.md b/docs/examples/ui.md
@@ -0,0 +1,36 @@
+# UI and Rendering
+
+These examples demonstrate how to use React Table with your favorite UI libraries or tools!
+
+## Virtualized Rows (React-Window)
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/virtualized-rows)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/virtualized-rows)
+
+## Animated (Framer-Motion)
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/animated-framer-motion)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/animated-framer-motion)
+
+## Material-UI
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/material-UI-components)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/material-UI-components)
+
+## Material-UI Enhanced Table
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/material-UI-enhanced-table)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/material-UI-enhanced-table)
+
+## RMWC Table
+
+- [Source](https://github.com/tannerlinsley/react-table/tree/master/examples/rmwc-components)
+- [Open in CodeSandbox](https://codesandbox.io/s/github/tannerlinsley/react-table/tree/master/examples/rmwc-components)
+
+## Todo
+
+- [ ] Styled-Components
+- [ ] CSS
+- [ ] Bootstrap
+
+* Want to write one of these examples or add another? [Submit a PR!](https://github.com/tannerlinsley/react-table/compare)