Skip to content

Commit

Permalink
chore: Add note about rimraf
Browse files Browse the repository at this point in the history
  • Loading branch information
TimothyJones committed May 29, 2024
1 parent 0f36c79 commit 4cff799
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,12 @@ function maxArray(arr: number[]): number {

By using `example-extractor`, you can easily maintain and manage code examples for documentation purposes, ensuring that your examples are always up-to-date with your source code.

### Clearing the examples directory

Since we want the examples to be fresh each time, example-extractor expects an empty directory. To help you remember this, it will fail if it tries to overwrite an example.

We recommend clearing out your examples directory each time using something like [rimraf](https://www.npmjs.com/package/rimraf).

## Usage

```sh
Expand Down

0 comments on commit 4cff799

Please sign in to comment.