docs site for @testing-library/*
![All Contributors][allcontributors-badge]
[![Code of Conduct][coc-badge]][coc]
Documentation site for
React Testing Library,
DOM Testing Library,
and related projects
Build Status:
![Netlify Status][netlify-badge]
[netlify-badge]:
https://api.netlify.com/api/v1/badges/24366204-84ca-41e9-b573-2a64f0845e46/deploy-status
[allcontributors-badge]:
https://img.shields.io/github/all-contributors/testing-library/testing-library-docs?color=ee8449&style=flat-square
[coc-badge]:
https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
[coc]:
https://github.com/testing-library/react-testing-library/blob/main/CODE_OF_CONDUCT.md
This website was created with Docusaurus.
# Install dependencies$ npm install
# Start the site$ npm start
Edit docs by navigating to docs/ and editing the corresponding document:
docs/doc-to-be-edited.mdx
---id: page-needs-edittitle: This Doc Needs To Be Edited---Edit me...
For more information about docs, click here
Edit blog posts by navigating to blog and editing the corresponding post:
blog/post-to-be-edited.mdx
---id: post-needs-edittitle: This Blog Post Needs To Be Edited---Edit me...
For more information about blog posts, click
here
/docs, exampledocs/newly-created-doc.mdx:
---id: newly-created-doctitle: 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. ‘*‘.
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
Thanks goes to these wonderful people
(emoji key):
This project follows the
all-contributors
specification. Contributions of any kind welcome!
