testing-library-docs

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

https://testing-library.com

Build Status:

This website was created with Docusaurus.

What's In This Document

Get Started in 5 Minutes
Editing Content
Adding Content

Get Started in 5 Minutes

Make sure all the dependencies for the website are installed:

# Install dependencies
$ npm install

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

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

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} 🚧	_{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} 📖

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

License

mcous/testing-library-docs

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages