Awesome

testing-library-docs

Documentation site for React Testing Library, DOM Testing Library, and related projects

https://testing-library.com

Build Status:

This website was created with Docusaurus.

What's In This Document

• Get Started in 5 Minutes
• Editing Content
• Adding Content

Get Started in 5 Minutes

1. Make sure all the dependencies for the website are installed:

# Install dependencies
$ npm install

2. 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. '*'.

2. 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!