Skip to content

zhangzhaoaaa/testing-library-docs

Β 
Β 

Repository files navigation

testing-library-docs

All Contributors Code of Conduct

Documentation site for React Testing Library, DOM Testing Library, and related projects

https://testing-library.com

Build Status:

Netlify Status

This website was created with Docusaurus.

What's In This Document

Get Started in 5 Minutes

  1. Make sure all the dependencies for the website are installed:
# Install dependencies
$ npm install
  1. Run your dev server:
# 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

---
id: page-needs-edit
title: This Doc Needs To Be Edited
---

Edit me...

For more information about docs, click here

Editing an existing blog post

Edit blog posts by navigating to blog and editing the corresponding post:

blog/post-to-be-edited.mdx

---
id: post-needs-edit
title: This Blog Post Needs To Be Edited
---

Edit me...

For more information about blog posts, click here

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:
---
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. '*'.

  1. Refer to that doc's ID in an existing sidebar in sidebar.json:
// 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

Contributors

Thanks goes to these wonderful people (emoji key):

Kent C. Dodds
Kent C. Dodds

🚧
Alex Krolick
Alex Krolick

🚧
Sidak Singh Aulakh
Sidak Singh Aulakh

πŸ’»
Brandon Carroll
Brandon Carroll

πŸ’»
David
David

πŸ“–
Ryan James
Ryan James

πŸ“–
Brandon Johnson
Brandon Johnson

πŸ“–
Edward Coleridge Smith
Edward Coleridge Smith

πŸ“–
AdriΓ  Fontcuberta
AdriΓ  Fontcuberta

πŸ“– πŸ‘€
Tim Deschryver
Tim Deschryver

πŸ“– πŸ’»
Ben Monro
Ben Monro

πŸ“–
Scott Sauber
Scott Sauber

πŸ“
Shota Tamura
Shota Tamura

πŸ–‹ πŸ“–
Giorgio Polvara
Giorgio Polvara

πŸ“–
michalak111
michalak111

πŸ“– ⚠️
Huyen Nguyen
Huyen Nguyen

πŸ“–
Kieren Hughes
Kieren Hughes

πŸ“–
Sean McPherson
Sean McPherson

πŸ“–
Michael Lasky
Michael Lasky

πŸ“–
Thomas Lombart
Thomas Lombart

πŸ“–
Patrick K Long
Patrick K Long

πŸ“–
Pedro Filho
Pedro Filho

πŸ“–
Tanguy Antoine
Tanguy Antoine

πŸ“–
Kevin Anderson
Kevin Anderson

πŸ“–
Dustin Myers
Dustin Myers

πŸ“–
Vojta Holik
Vojta Holik

🎨
Steve Schwarz
Steve Schwarz

πŸ“–
Aayush Rajvanshi
Aayush Rajvanshi

πŸ“–
Eugie Limpin
Eugie Limpin

πŸ“–
Kevin
Kevin

πŸ“–
Jennifer Shehane
Jennifer Shehane

πŸ“–
Steve Taggart
Steve Taggart

πŸ“–
Stephen Sugden
Stephen Sugden

πŸ“–
Blai Samitier
Blai Samitier

πŸ“–
Vernon Kesner
Vernon Kesner

πŸ“–
Will Douglas
Will Douglas

πŸ“–
Head
Head

πŸ“–
Lee
Lee

πŸ“–
Mario BeltrΓ‘n AlarcΓ³n
Mario BeltrΓ‘n AlarcΓ³n

πŸ“–
jameslevine
jameslevine

πŸ“–
Rahim Alwer
Rahim Alwer

πŸ“–
Chenjia
Chenjia

πŸ“–
Olivier Le Thanh Duong
Olivier Le Thanh Duong

πŸ“–
Jakub JastrzΔ™bski
Jakub JastrzΔ™bski

πŸ“–
Ivan Galiatin
Ivan Galiatin

πŸ“–
Hendrik RΓΆhm
Hendrik RΓΆhm

πŸ“–
Sam Kauffman
Sam Kauffman

πŸ“–
Turadg Aleahmad
Turadg Aleahmad

πŸ“–
mark g romano
mark g romano

πŸ“–
Arturo Romero
Arturo Romero

πŸ“–
Dustin Masters
Dustin Masters

πŸ“–
Darren Lester
Darren Lester

πŸ“–
Iswara Chaitanya
Iswara Chaitanya

πŸ“–
Nataliia Pylypenko
Nataliia Pylypenko

πŸ“–
Hu Chen
Hu Chen

πŸ“–
Josh
Josh

πŸ“–
numb86
numb86

πŸ“–
Nicholas Boll
Nicholas Boll

πŸ“–
Billy Matthews
Billy Matthews

πŸ“’ πŸ“–
Dale French
Dale French

πŸ“–
aw-davidson
aw-davidson

πŸ“–
Benjamin Blackwood
Benjamin Blackwood

πŸ“–
Ben
Ben

πŸ“–
Daniel Afonso
Daniel Afonso

πŸ“–
Noman Gul
Noman Gul

πŸ“–
Rafael Souza
Rafael Souza

πŸ“–
Pavel Pustovalov
Pavel Pustovalov

πŸ“–
Dyma
Dyma

πŸ“–
Matan Borenkraout
Matan Borenkraout

πŸ“– πŸ’»
timrobinson33
timrobinson33

πŸ“–
Manuel DuguΓ©
Manuel DuguΓ©

πŸ“–
karthik20
karthik20

πŸ“–
Pob Ch
Pob Ch

πŸ“–
Mohammad Kermani
Mohammad Kermani

πŸ“–
Adeel Imran
Adeel Imran

πŸ“–
Varun Dey
Varun Dey

πŸ“–
Pablo R. Dinella
Pablo R. Dinella

πŸ“–
Jamie
Jamie

πŸ“–
Cory House
Cory House

πŸ“–
Jack Zhao
Jack Zhao

πŸ“–
Ryan Kennel
Ryan Kennel

πŸ“–
Jesus Hernandez
Jesus Hernandez

πŸ“–
Aaron Pettengill
Aaron Pettengill

πŸ“–
Izhaki
Izhaki

πŸ“–
Robin Wieruch
Robin Wieruch

βœ…
Alexander Sokolov
Alexander Sokolov

πŸ“–
Sascha Tandel
Sascha Tandel

πŸ“–
Gyuwon Yi
Gyuwon Yi

πŸ“–
Boris Serdiuk
Boris Serdiuk

πŸ“–
balavishnuvj
balavishnuvj

πŸ“–
Sharmila Jesupaul
Sharmila Jesupaul

πŸ“–
Batuhan Wilhelm
Batuhan Wilhelm

πŸ“–
Dennis Kaffer
Dennis Kaffer

πŸ“–
Cam Jackson
Cam Jackson

πŸ“–
Jared Luxenberg
Jared Luxenberg

πŸ“–
Yakir Narkis
Yakir Narkis

πŸ“–
Rahul Bhooteshwar
Rahul Bhooteshwar

πŸ“–
Maja Wichrowska
Maja Wichrowska

πŸ“–
Kermani
Kermani

πŸ“– πŸ‘€
Vasily Malykhin
Vasily Malykhin

πŸ“–
Brian Alexis
Brian Alexis

πŸ“–
Kalpesh Singh
Kalpesh Singh

πŸ“–
Gerrit Alex
Gerrit Alex

πŸ“–
Winter LaMon
Winter LaMon

πŸ“–
Juliano Penna
Juliano Penna

πŸ“–
Paul Coroneos
Paul Coroneos

πŸ“–
Sebastian Silbermann
Sebastian Silbermann

πŸ“– πŸ‘€
Paul Salaets
Paul Salaets

πŸ“–
MichaΓ«l De Boey
MichaΓ«l De Boey

πŸ“–
Washington Soares
Washington Soares

πŸ“–
Jami Suomalainen
Jami Suomalainen

πŸ“–
Oriol Puig
Oriol Puig

πŸ“–
hedgecox
hedgecox

πŸ“–
Sherman Hui
Sherman Hui

πŸ“–
Jesu Castillo
Jesu Castillo

πŸ“–
Core HTML5 Canvas, the book
Core HTML5 Canvas, the book

πŸ“–
John Sterling
John Sterling

πŸ“–
Velu S Gautam
Velu S Gautam

πŸ“–
Richard Oliver Bray
Richard Oliver Bray

πŸ“–
Yanlin Jiang
Yanlin Jiang

πŸ“–
Lidor Avitan
Lidor Avitan

πŸ“–
Isaiah Thomason
Isaiah Thomason

πŸ“–
Denis Barushev
Denis Barushev

πŸ“–
Domas
Domas

πŸ“–
Anton Niklasson
Anton Niklasson

πŸ“–
Nikolai Yakuschenko
Nikolai Yakuschenko

πŸ“–
Jan SchrΓΆder
Jan SchrΓΆder

πŸ“–
Nick McCurdy
Nick McCurdy

πŸ“– πŸ‘€ πŸ’»
Sudhanshu
Sudhanshu

πŸ“–
Aleksandr Chernov
Aleksandr Chernov

πŸ“–
Mathias
Mathias

πŸ“–
davidseow
davidseow

πŸ“–
Tony Hallett
Tony Hallett

πŸ“–
prsdta
prsdta

πŸ“–
tal-joffe
tal-joffe

πŸ“–
Mayank Jethva
Mayank Jethva

πŸ“–
Elad Israeli
Elad Israeli

πŸ“–
Francis Chartrand
Francis Chartrand

πŸ“–
Preston Carman
Preston Carman

πŸ“–
Olivier Wilkinson
Olivier Wilkinson

πŸ“–
Amit Miran
Amit Miran

πŸ“–
Paul Melero
Paul Melero

πŸ“–
jonathan schatz
jonathan schatz

πŸ“–
Ricky Sullivan Himself
Ricky Sullivan Himself

πŸ“–
Armin
Armin

πŸ“–
Dale Baldwin
Dale Baldwin

πŸ“–
AdriSolid
AdriSolid

πŸ“–
Naruth Kongurai
Naruth Kongurai

πŸ“–
Erfan Mirzapour
Erfan Mirzapour

πŸ“–
Shem Mahluf
Shem Mahluf

πŸ’» πŸš‡ πŸ“–
Phil Gibbins
Phil Gibbins

πŸ“–
Liad Shiran
Liad Shiran

πŸ“–
Eduardo SimΓ³n PicΓ³n
Eduardo SimΓ³n PicΓ³n

πŸ“–
Sanjeev Sharma
Sanjeev Sharma

πŸ“–
dror-heller
dror-heller

πŸ“–
Aleksei Arro
Aleksei Arro

πŸ“–
Carlo Beltrame
Carlo Beltrame

πŸ“–
ggorlen
ggorlen

πŸ“–
mattstobbs
mattstobbs

πŸ“–
Zach
Zach

πŸ“–
Angus J. Pope
Angus J. Pope

πŸ“–
Dylan Piercey
Dylan Piercey

πŸ“–
Ruhollah
Ruhollah

πŸ“–
Michael Gwynne
Michael Gwynne

πŸ“–
Dominik Broj
Dominik Broj

πŸ“–
Stephen Wade
Stephen Wade

πŸ“–
Luiz Baldi
Luiz Baldi

πŸ“–
Thomas Ingram
Thomas Ingram

πŸ“–
David Johnston
David Johnston

πŸ“–
Rupert McKay
Rupert McKay

πŸ“–
SebastiΓ‘n Maciel
SebastiΓ‘n Maciel

πŸ“–
Sidharth Vinod
Sidharth Vinod

πŸ“–
Honza Kalfus
Honza Kalfus

πŸ“–
Christopher Laidler
Christopher Laidler

πŸ“–
Nik Savchenko
Nik Savchenko

πŸ“–
Steven Frieson
Steven Frieson

πŸ“–
Andrew RosΓ‘rio
Andrew RosΓ‘rio

πŸ“–
Daniel RB
Daniel RB

πŸ“–
HonkingGoose
HonkingGoose

πŸ“–
Daniel Kolev
Daniel Kolev

πŸ“–
Arryangga Aliev Pratamaputra
Arryangga Aliev Pratamaputra

πŸ“–
Andrew Hansen
Andrew Hansen

πŸ“–
JOAO GABRIEL SANTOS NEVES
JOAO GABRIEL SANTOS NEVES

πŸ“–
Luke Ingalls
Luke Ingalls

πŸ“–
Aleksey Levenstein
Aleksey Levenstein

πŸ“–
Tomas Zaicevas
Tomas Zaicevas

πŸ“–
Sriram Thiagarajan
Sriram Thiagarajan

πŸ“–
Esteban Borai
Esteban Borai

πŸ“–
Arti Villa
Arti Villa

πŸ“–
Jake Boone
Jake Boone

πŸ“–
Dennis273
Dennis273

πŸ“–
Mosh Feu
Mosh Feu

πŸ“–
Notas Hellout
Notas Hellout

πŸ“–
Max Smolens
Max Smolens

πŸ“–
Nima Ebrazeh
Nima Ebrazeh

πŸ“–
Philipp Fritsche
Philipp Fritsche

πŸ‘€
ClΓ©ment Plantier
ClΓ©ment Plantier

πŸ“–
pppp606
pppp606

πŸ“–
Bilou
Bilou

πŸ“–
David Hewson
David Hewson

πŸ“–
Alex Kim
Alex Kim

πŸ“–
PaquitoSoft
PaquitoSoft

πŸ“–
MΓ‘rcio Gabriel
MΓ‘rcio Gabriel

πŸ“–
Krychaxp
Krychaxp

πŸ“–
momokolo
momokolo

πŸ“–
AndyG
AndyG

πŸ“–
Jason Butz
Jason Butz

πŸš‡
Oleg
Oleg

πŸ“–
Dany Paredes
Dany Paredes

πŸ“–
Abel
Abel

πŸ“–
Patrick Brady
Patrick Brady

πŸ“–
Grant Eaton
Grant Eaton

πŸ“–
Aaron Dunphy
Aaron Dunphy

πŸ“–
Tom Mrazauskas
Tom Mrazauskas

πŸ“–
Supermaryy
Supermaryy

πŸ“–
Ben Newton
Ben Newton

πŸ“–
Matija Marohnić
Matija Marohnić

πŸ“–
Thaddeus Jiang
Thaddeus Jiang

πŸ“–
Robin Drexler
Robin Drexler

πŸ“–
Thomas McKee
Thomas McKee

πŸ“–
satanTime
satanTime

πŸ“–
polinamochan
polinamochan

πŸ“–
Shai Rose
Shai Rose

πŸ“–
AldinRekic
AldinRekic

🎨
Son Nguyen
Son Nguyen

πŸ“–
Lirlev48
Lirlev48

πŸ“–
Tarjei Huse
Tarjei Huse

πŸ“–
Obie Munoz
Obie Munoz

πŸ“–
Bert B
Bert B

πŸ“–
Alireza Heydari
Alireza Heydari

πŸ“–
Gleb Radutsky
Gleb Radutsky

πŸ“–
giovanniPepi
giovanniPepi

πŸ“–
Maciej Jastrzebski
Maciej Jastrzebski

πŸ“–
Sergio Moreno
Sergio Moreno

πŸ’»
David Nixon
David Nixon

πŸ“–
Anton Khitrenovich
Anton Khitrenovich

πŸ“–
Kostas Minaidis
Kostas Minaidis

πŸ“–
Than Hutchins
Than Hutchins

πŸ“–
Jordan Edmunds
Jordan Edmunds

πŸ“–

This project follows the all-contributors specification. Contributions of any kind welcome!

About

docs site for @testing-library/*

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 83.1%
  • CSS 16.9%