-
Notifications
You must be signed in to change notification settings - Fork 725
Clean up sidebar #35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Clean up sidebar #35
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6c8d190
condense sidebar elements with only one child to a single nav entry
alexkrolick 561fcf1
add full titles for shorter lib docs
alexkrolick 33c9161
condense reason docs and add more links to reasonml docs
alexkrolick 5fb71e7
fix unreadable link color
alexkrolick 80f3ac6
fix homepage layout
alexkrolick 563871a
fix broken svg
alexkrolick e9723f8
Update docs/bs-react-testing-library/examples.md
wyze File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,76 @@ | ||
--- | ||
id: intro | ||
title: Introduction | ||
title: Reason Testing Library | ||
sidebar_label: Introduction | ||
--- | ||
|
||
[`bs-react-testing-library`][gh] contains | ||
Bindings for several testing libraries have been ported to [ReasonML][re]. | ||
|
||
[`bs-react-testing-library`][gh-react] contains | ||
[BuckleScript](https://bucklescript.github.io/) bindings for | ||
`react-testing-library`. | ||
|
||
[`bs-dom-testing-library`][gh-dom] contains [BuckleScript][bs] bindings for | ||
`dom-testing-library`. | ||
|
||
``` | ||
npm install --save-dev bs-dom-testing-library | ||
npm install --save-dev bs-react-testing-library | ||
``` | ||
|
||
- [bs-react-testing-library on GitHub][gh] | ||
- [bs-react-testing-library on GitHub][gh-react] | ||
- [bs-dom-testing-library on GitHub][gh-dom] | ||
|
||
[gh]: https://github.com/wyze/bs-react-testing-library | ||
[gh-dom]: https://github.com/wyze/bs-dom-testing-library | ||
[gh-react]: https://github.com/wyze/bs-react-testing-library | ||
|
||
## Setup | ||
|
||
After installation, you will need to add it to your `bsconfig.json` file like | ||
so: | ||
After installation, you will need the packages `bsconfig.json` file like so: | ||
|
||
```json | ||
{ | ||
"bs-dev-dependencies": ["bs-react-testing-library"] | ||
} | ||
``` | ||
|
||
_or_ | ||
|
||
```json | ||
{ | ||
"bs-dev-dependencies": ["bs-dom-testing-library"] | ||
} | ||
``` | ||
|
||
## Other Dependencies | ||
|
||
### bs-platform | ||
|
||
This is what [BuckleScript][bs] uses to compile the [Reason][re] code to JS. If | ||
it is not in your project you can install it like so: | ||
|
||
``` | ||
npm install --save-dev bs-platform | ||
``` | ||
|
||
### bs-jest | ||
|
||
This is the recommended test runner and is a wrapper around Jest. All of the | ||
examples here will be using it. | ||
|
||
- [bs-jest on GitHub](https://github.com/glennsl/bs-jest) | ||
|
||
``` | ||
npm install --save-dev @glennsl/bs-jest | ||
``` | ||
|
||
Then update `bsconfig.json`: | ||
|
||
```json | ||
{ | ||
"bs-dev-dependencies": ["@glennsl/bs-jest"] | ||
} | ||
``` | ||
|
||
[bs]: https://bucklescript.github.io/ | ||
[re]: https://reasonml.github.io/ |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.