docs: add website built with Docusaurus (#74)

* Run docusaurus init

* Add api.md and remove initial files

* Run docusaurus init

* Add api.md and remove initial files

* Add callstack info and remove extra scripts

* Commeent out  extra features on home page and Add link to example

* Re Arrange Docs Folder

* add some adjustments

* fix lint

* fix lint
This commit is contained in:
Brooks Becton
2018-12-11 12:58:37 -06:00
committed by Michał Pierzchała
parent 1673bc0fdd
commit ad61c409e9
23 changed files with 6671 additions and 8 deletions
+6 -6
View File
@@ -66,13 +66,13 @@ As you may have noticed, it's not tied to React Native at all – you can safely
## API / Usage
The [public API](docs/api.md) of `react-native-testing-library` is focused around these essential methods:
The [public API](docs/API.md) of `react-native-testing-library` is focused around these essential methods:
- [`render`](docs/api.md#render) – deeply renders given React element and returns helpers to query the output components.
- [`shallow`](docs/api.md#shallow) – shallowly renders given React component. It doesn't return any helpers to query the output.
- [`fireEvent`](docs/api.md#fireevent) - invokes named event handler on the element.
- [`waitForElement`](docs/api.md#waitforelement) - waits for non-deterministic periods of time until your element appears or times out.
- [`flushMicrotasksQueue`](docs/api.md#flushmicrotasksqueue) - waits for microtasks queue to flush.
- [`render`](docs/API.md#render) – deeply renders given React element and returns helpers to query the output components.
- [`shallow`](docs/API.md#shallow) – shallowly renders given React component. It doesn't return any helpers to query the output.
- [`fireEvent`](docs/API.md#fireevent) - invokes named event handler on the element.
- [`waitForElement`](docs/API.md#waitforelement) - waits for non-deterministic periods of time until your element appears or times out.
- [`flushMicrotasksQueue`](docs/API.md#flushmicrotasksqueue) - waits for microtasks queue to flush.
<!-- badges -->