Skip to content

Commit 72f30e7

Browse files
committed
fix: update typedoc config
1 parent eae3890 commit 72f30e7

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,16 @@ Clone the repository:
2525
git clone --depth 1 git@github.com:alioguzhan/react-typescript-library.git
2626
```
2727

28+
Rename the cloned folder to your library/component name:
29+
30+
```
31+
mv react-typescript-library my-react-lib
32+
```
33+
2834
Install the deps:
2935

3036
```bash
37+
cd my-react-lib
3138
yarn install
3239
```
3340

src/__tests__/index.test.tsx

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
import { render } from '@testing-library/react';
2-
import React from 'react';
32
import Main from '../index';
43

54
describe('My Component', () => {

typedoc.json

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
{
22
"out": "docs",
3-
"inputFiles": "./src",
4-
"mode": "modules",
3+
"entryPoints": ["./src"],
4+
"exclude": "**/**/*+(.spec|.test).**",
55
"theme": "default",
6-
"excludeNotExported": true,
76
"includeVersion": true,
87
"categorizeByGroup": true
98
}

0 commit comments

Comments
 (0)