Skip to content

Commit

Permalink
fix: update typedoc config
Browse files Browse the repository at this point in the history
  • Loading branch information
alioguzhan committed Jan 4, 2021
1 parent eae3890 commit 72f30e7
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 4 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,16 @@ Clone the repository:
git clone --depth 1 git@github.com:alioguzhan/react-typescript-library.git
```

Rename the cloned folder to your library/component name:

```
mv react-typescript-library my-react-lib
```

Install the deps:

```bash
cd my-react-lib
yarn install
```

Expand Down
1 change: 0 additions & 1 deletion src/__tests__/index.test.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { render } from '@testing-library/react';
import React from 'react';
import Main from '../index';

describe('My Component', () => {
Expand Down
5 changes: 2 additions & 3 deletions typedoc.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
{
"out": "docs",
"inputFiles": "./src",
"mode": "modules",
"entryPoints": ["./src"],
"exclude": "**/**/*+(.spec|.test).**",
"theme": "default",
"excludeNotExported": true,
"includeVersion": true,
"categorizeByGroup": true
}

0 comments on commit 72f30e7

Please sign in to comment.