testing-library-docs
![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.
What's In This Document
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 startEditing 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, 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. '*'.
- 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):
This project follows the all-contributors specification. Contributions of any kind welcome!