Skip to content
main
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.

testing-library-docs

Open Collective Sponsors and Backers 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

🚧

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

📖

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