GitHub - testing-library/testing-library-docs: docs site for @testing-library/* (original) (raw)

testing-library-docs

All Contributors Code of Conduct

Documentation site forReact 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, clickhere

Adding Content

Adding a new docs page to an existing sidebar

  1. Create the doc as a new markdown file in /docs, exampledocs/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, clickhere

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πŸ“– mouse mouseπŸ“– Roberto Molina Roberto MolinaπŸ“– Louis Young Louis YoungπŸ“– Lukas Elmer Lukas ElmerπŸ“– Brent Guffens Brent GuffensπŸ“– Esteban EstebanπŸ“–
Tibor Barsi Tibor BarsiπŸ“– Tomoya Kashifuku Tomoya KashifukuπŸ“– Leo LeoπŸ“– Erik Metz Erik MetzπŸ“– Vaibhav Tyagi Vaibhav TyagiπŸ“– Aleksei Drokin Aleksei DrokinπŸ“– Torsten Knauf Torsten KnaufπŸ“–
John Harlow John HarlowπŸ“– Morgan Hunter Morgan HunterπŸ“– Louis Moselhi Louis MoselhiπŸ“– Ryan McGill Ryan McGillπŸ“– Renan Andrade Renan AndradeπŸ“– Vasilii Boldurean Vasilii BoldureanπŸ“– Josias Schneider Josias SchneiderπŸ“–
Denis LE Denis LEπŸ“– Nicolas Frizzarin Nicolas FrizzarinπŸ“– Santosh Yadav Santosh YadavπŸ“– IlΓͺ Caian IlΓͺ CaianπŸ“– Alex Khomenko Alex KhomenkoπŸ“– LuΓ­s Campos LuΓ­s CamposπŸ“– Alexandr Zhidovlenko Alexandr ZhidovlenkoπŸ“–
lyannel lyannel️️️️♿️ Yanick Champoux Yanick ChampouxπŸ“– Ali AliπŸ“– Milan Jaritz Milan JaritzπŸ“– Rokas BrazdΕΎionis Rokas BrazdΕΎionisπŸ“– Laforge Thomas Laforge ThomasπŸ“– Steph Nathai Steph NathaiπŸ’» ️️️️♿️
Frieder Bluemle Frieder BluemleπŸ“– Gromit (μ „λ―Όμž¬) Gromit (μ „λ―Όμž¬)πŸ“– Cesar S Cesar SπŸ“– Corbin Crutchley Corbin CrutchleyπŸ“– Roman Batsenko Roman BatsenkoπŸ“– snjro snjroπŸ“– taro taroπŸ“–
Andreas Nordahl Andreas NordahlπŸ“– neaumusic neaumusicπŸ“– Joyel Johny Joyel JohnyπŸ’» bsheps bshepsπŸ“– Kyle Nazario Kyle NazarioπŸ“– Giuliano Crivelli Giuliano CrivelliπŸ“– mrkv mrkvπŸ“–
smk267 smk267πŸš‡ Dylan Gordon Dylan GordonπŸ“– Michael Cousins Michael CousinsπŸ“– πŸ‘€ Artem Zakharchenko Artem ZakharchenkoπŸ“– Vadim Shvetsov Vadim ShvetsovπŸ“– Domantas Petrauskas Domantas PetrauskasπŸ“– Efim EfimπŸ“–
denisx denisxπŸ’» Giovanni Gualiato Giovanni GualiatoπŸ“– Saud Baig Saud BaigπŸ“– Ren Adachi Ren AdachiπŸ“– Ty Mick Ty MickπŸ“– Enmanuel DurΓ‘n Enmanuel DurΓ‘nπŸ“– Galeel Bhasha Satthar Galeel Bhasha SattharπŸ“–
Ian LΓ©tourneau Ian LΓ©tourneauπŸ“– brianlu2610 brianlu2610πŸ’» Erin ErinπŸ“– Nan Chen Nan ChenπŸ“– Alexander Burdiss Alexander BurdissπŸ“– Peter Hentges Peter HentgesπŸ“– neknalb neknalbπŸ“–
fetsorn fetsornπŸ“–

This project follows theall-contributorsspecification. Contributions of any kind welcome!