/testing-library-docs

docs site for @testing-library/*

Primary LanguageJavaScriptMIT LicenseMIT

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

πŸ“–

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