https://github.com/testing-library/testing-library-docs
docs site for @testing-library/*
https://github.com/testing-library/testing-library-docs
docs docusaurus jest jsdom react react-testing-library testing testing-library
Last synced: 9 months ago
JSON representation
docs site for @testing-library/*
- Host: GitHub
- URL: https://github.com/testing-library/testing-library-docs
- Owner: testing-library
- License: mit
- Created: 2018-12-30T00:06:37.000Z (almost 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-26T07:08:21.000Z (about 1 year ago)
- Last Synced: 2024-10-29T17:31:12.675Z (about 1 year ago)
- Topics: docs, docusaurus, jest, jsdom, react, react-testing-library, testing, testing-library
- Language: JavaScript
- Homepage: https://testing-library.com
- Size: 16.9 MB
- Stars: 453
- Watchers: 15
- Forks: 709
- Open Issues: 67
-
Metadata Files:
- Readme: README.md
- Contributing: docs/contributing.mdx
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-list - testing-library-docs - library/* | testing-library | 314 | (JavaScript)
README
## testing-library-docs
[![All Contributors][allcontributors-badge]](#contributors)
[![Code of Conduct][coc-badge]][coc]
Documentation site for
[React Testing Library](https://github.com/testing-library/react-testing-library),
[DOM Testing Library](https://github.com/testing-library/dom-testing-library),
and [related projects](https://github.com/testing-library)
**https://testing-library.com**
**Build Status**:
[![Netlify Status][netlify-badge]][build]
[netlify-badge]:
https://api.netlify.com/api/v1/badges/24366204-84ca-41e9-b573-2a64f0845e46/deploy-status
[build]: https://app.netlify.com/sites/testing-library/deploys
[allcontributors-badge]:
https://img.shields.io/github/all-contributors/testing-library/testing-library-docs?color=ee8449&style=flat-square
[coc-badge]:
https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]:
https://github.com/testing-library/react-testing-library/blob/main/CODE_OF_CONDUCT.md
This website was created with [Docusaurus](https://v2.docusaurus.io).
# What's In This Document
- [Get Started in 5 Minutes](#get-started-in-5-minutes)
- [Editing Content](#editing-content)
- [Adding Content](#adding-content)
# Get Started in 5 Minutes
1. Make sure all the dependencies for the website are installed:
```sh
# Install dependencies
$ npm install
```
2. Run your dev server:
```sh
# Start the site
$ npm start
```
# Editing Content
## Editing an existing docs page
Edit docs by navigating to `docs/` and editing the corresponding document:
`docs/doc-to-be-edited.mdx`
```markdown
---
id: page-needs-edit
title: This Doc Needs To Be Edited
---
Edit me...
```
For more information about docs, click [here](https://v2.docusaurus.io/docs)
## Editing an existing blog post
Edit blog posts by navigating to `blog` and editing the corresponding post:
`blog/post-to-be-edited.mdx`
```markdown
---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---
Edit me...
```
For more information about blog posts, click
[here](https://v2.docusaurus.io/docs/blog)
# Adding Content
## Adding a new docs page to an existing sidebar
1. Create the doc as a new markdown file in `/docs`, example
`docs/newly-created-doc.mdx`:
```md
---
id: newly-created-doc
title: This Doc Needs To Be Edited
---
My new content here..
```
Note: Ensure the file name and the id value do not include non-url safe
characters i.e. '\*'.
2. Refer to that doc's ID in an existing sidebar in `sidebar.json`:
```javascript
// Add newly-created-doc to the Getting Started category of docs
{
"docs": {
"Getting Started": [
"quick-start",
"newly-created-doc" // new doc here
],
...
},
...
}
```
For more information about adding new docs, click
[here](https://v2.docusaurus.io/docs/)
## Contributors
Thanks goes to these wonderful people
([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Kent C. Dodds
π§
Alex Krolick
π§
Sidak Singh Aulakh
π»
Brandon Carroll
π»
David
π
Ryan James
π
Brandon Johnson
π
Edward Coleridge Smith
π
AdriΓ Fontcuberta
π π
Tim Deschryver
π π»
Ben Monro
π
Scott Sauber
π
Shota Tamura
π π
Giorgio Polvara
π
michalak111
π β οΈ
Huyen Nguyen
π
Kieren Hughes
π
Sean McPherson
π
Michael Lasky
π
Thomas Lombart
π
Patrick K Long
π
Pedro Filho
π
Tanguy Antoine
π
Kevin Anderson
π
Dustin Myers
π
Vojta Holik
π¨
Steve Schwarz
π
Aayush Rajvanshi
π
Eugie Limpin
π
Kevin
π
Jennifer Shehane
π
Steve Taggart
π
Stephen Sugden
π
Blai Samitier
π
Vernon Kesner
π
Will Douglas
π
Head
π
Lee
π
Mario BeltrΓ‘n AlarcΓ³n
π
jameslevine
π
Rahim Alwer
π
Chenjia
π
Olivier Le Thanh Duong
π
Jakub JastrzΔbski
π
Ivan Galiatin
π
Hendrik RΓΆhm
π
Sam Kauffman
π
Turadg Aleahmad
π
mark g romano
π
Arturo Romero
π
Dustin Masters
π
Darren Lester
π
Iswara Chaitanya
π
Nataliia Pylypenko
π
Hu Chen
π
Josh
π
numb86
π
Nicholas Boll
π
Billy Matthews
π’ π
Dale French
π
aw-davidson
π
Benjamin Blackwood
π
Ben
π
Daniel Afonso
π
Noman Gul
π
Rafael Souza
π
Pavel Pustovalov
π
Dyma
π
Matan Borenkraout
π π»
timrobinson33
π
Manuel DuguΓ©
π
karthik20
π
Pob Ch
π
Mohammad Kermani
π
Adeel Imran
π
Varun Dey
π
Pablo R. Dinella
π
Jamie
π
Cory House
π
Jack Zhao
π
Ryan Kennel
π
Jesus Hernandez
π
Aaron Pettengill
π
Izhaki
π
Robin Wieruch
β
Alexander Sokolov
π
Sascha Tandel
π
Gyuwon Yi
π
Boris Serdiuk
π
balavishnuvj
π
Sharmila Jesupaul
π
Batuhan Wilhelm
π
Dennis Kaffer
π
Cam Jackson
π
Jared Luxenberg
π
Yakir Narkis
π
Rahul Bhooteshwar
π
Maja Wichrowska
π
Kermani
π π
Vasily Malykhin
π
Brian Alexis
π
Kalpesh Singh
π
Gerrit Alex
π
Winter LaMon
π
Juliano Penna
π
Paul Coroneos
π
Sebastian Silbermann
π π
Paul Salaets
π
MichaΓ«l De Boey
π
Washington Soares
π
Jami Suomalainen
π
Oriol Puig
π
hedgecox
π
Sherman Hui
π
Jesu Castillo
π
Core HTML5 Canvas, the book
π
John Sterling
π
Velu S Gautam
π
Richard Oliver Bray
π
Yanlin Jiang
π
Lidor Avitan
π
Isaiah Thomason
π
Denis Barushev
π
Domas
π
Anton Niklasson
π
Nikolai Yakuschenko
π
Jan SchrΓΆder
π
Nick McCurdy
π π π»
Sudhanshu
π
Aleksandr Chernov
π
Mathias
π
davidseow
π
Tony Hallett
π
prsdta
π
tal-joffe
π
Mayank Jethva
π
Elad Israeli
π
Francis Chartrand
π
Preston Carman
π
Olivier Wilkinson
π
Amit Miran
π
Paul Melero
π
jonathan schatz
π
Ricky Sullivan Himself
π
Armin
π
Dale Baldwin
π
AdriSolid
π
Naruth Kongurai
π
Erfan Mirzapour
π
Shem Mahluf
π» π π
Phil Gibbins
π
Liad Shiran
π
Eduardo SimΓ³n PicΓ³n
π
Sanjeev Sharma
π
dror-heller
π
Aleksei Arro
π
Carlo Beltrame
π
ggorlen
π
mattstobbs
π
Zach
π
Angus J. Pope
π
Dylan Piercey
π
Ruhollah
π
Michael Gwynne
π
Dominik Broj
π
Stephen Wade
π
Luiz Baldi
π
Thomas Ingram
π
David Johnston
π
Rupert McKay
π
SebastiΓ‘n Maciel
π
Sidharth Vinod
π
Honza Kalfus
π
Christopher Laidler
π
Nik Savchenko
π
Steven Frieson
π
Andrew RosΓ‘rio
π
Daniel RB
π
HonkingGoose
π
Daniel Kolev
π
Arryangga Aliev Pratamaputra
π
Andrew Hansen
π
JOAO GABRIEL SANTOS NEVES
π
Luke Ingalls
π
Aleksey Levenstein
π
Tomas Zaicevas
π
Sriram Thiagarajan
π
Esteban Borai
π
Arti Villa
π
Jake Boone
π
Dennis273
π
Mosh Feu
π
Notas Hellout
π
Max Smolens
π
Nima Ebrazeh
π
Philipp Fritsche
π
ClΓ©ment Plantier
π
pppp606
π
Bilou
π
David Hewson
π
Alex Kim
π
PaquitoSoft
π
MΓ‘rcio Gabriel
π
Krychaxp
π
momokolo
π
AndyG
π
Jason Butz
π
Oleg
π
Dany Paredes
π
Abel
π
Patrick Brady
π
Grant Eaton
π
Aaron Dunphy
π
Tom Mrazauskas
π
Supermaryy
π
Ben Newton
π
Matija MarohniΔ
π
Thaddeus Jiang
π
Robin Drexler
π
Thomas McKee
π
satanTime
π
polinamochan
π
Shai Rose
π
AldinRekic
π¨
Son Nguyen
π
Lirlev48
π
Tarjei Huse
π
Obie Munoz
π
Bert B
π
Alireza Heydari
π
Gleb Radutsky
π
giovanniPepi
π
Maciej Jastrzebski
π
Sergio Moreno
π»
David Nixon
π
Anton Khitrenovich
π
Kostas Minaidis
π
Than Hutchins
π
Jordan Edmunds
π
mouse
π
Roberto Molina
π
Louis Young
π
Lukas Elmer
π
Brent Guffens
π
Esteban
π
Tibor Barsi
π
Tomoya Kashifuku
π
Leo
π
Erik Metz
π
Vaibhav Tyagi
π
Aleksei Drokin
π
Torsten Knauf
π
John Harlow
π
Morgan Hunter
π
Louis Moselhi
π
Ryan McGill
π
Renan Andrade
π
Vasilii Boldurean
π
Josias Schneider
π
Denis LE
π
Nicolas Frizzarin
π
Santosh Yadav
π
IlΓͺ Caian
π
Alex Khomenko
π
LuΓs Campos
π
Alexandr Zhidovlenko
π
lyannel
οΈοΈοΈοΈβΏοΈ
Yanick Champoux
π
Ali
π
Milan Jaritz
π
Rokas BrazdΕΎionis
π
Laforge Thomas
π
Steph Nathai
π» οΈοΈοΈοΈβΏοΈ
Frieder Bluemle
π
Gromit (μ λ―Όμ¬)
π
Cesar S
π
Corbin Crutchley
π
Roman Batsenko
π
snjro
π
taro
π
Andreas Nordahl
π
neaumusic
π
Joyel Johny
π»
bsheps
π
Kyle Nazario
π
Giuliano Crivelli
π
mrkv
π
smk267
π
Dylan Gordon
π
Michael Cousins
π π
Artem Zakharchenko
π
Vadim Shvetsov
π
Domantas Petrauskas
π
Efim
π
denisx
π»
Giovanni Gualiato
π
Saud Baig
π
Ren Adachi
π
Ty Mick
π
Enmanuel DurΓ‘n
π
Galeel Bhasha Satthar
π
Ian LΓ©tourneau
π
brianlu2610
π»
Erin
π
Nan Chen
π
Alexander Burdiss
π
Peter Hentges
π
neknalb
π
This project follows the
[all-contributors](https://github.com/all-contributors/all-contributors)
specification. Contributions of any kind welcome!