Skip to content

Commit 1167481

Browse files
committed
Merge branch 'template'
2 parents 062b5c8 + 01ce577 commit 1167481

File tree

3 files changed

+39
-1
lines changed

3 files changed

+39
-1
lines changed

docs/docs/getting-started.mdx

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
sidebar_position: 0
3+
---
4+
5+
import { addNumber } from '@knide/fs-prober/src'
6+
7+
# Introduction
8+
9+
Package Description of `@knide/fs-prober` goes here.
10+
11+
## Installation
12+
13+
```sh
14+
# NPM
15+
npm install @knide/fs-prober
16+
17+
# Yarn
18+
yarn add @knide/fs-prober
19+
```
20+
21+
## Usage
22+
23+
### `addNumber`
24+
25+
### Overview
26+
27+
This function adds two numbers together.
28+
29+
**Example:**
30+
```js
31+
import { addNumber } from '@knide/fs-prober';
32+
33+
const result = addNumber(1, 2);
34+
```
35+
36+
Result: {addNumber(1, 2)}

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
"dependencies": {
1818
"@docusaurus/core": "3.6.3",
1919
"@docusaurus/preset-classic": "3.6.3",
20+
"@knide/fs-prober": "*",
2021
"@mdx-js/react": "^3.0.0",
2122
"clsx": "^2.0.0",
2223
"prism-react-renderer": "^2.3.0",

yarn.lock

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3309,7 +3309,7 @@ __metadata:
33093309
languageName: node
33103310
linkType: hard
33113311

3312-
"@knide/fs-prober@workspace:package":
3312+
"@knide/fs-prober@npm:*, @knide/fs-prober@workspace:package":
33133313
version: 0.0.0-use.local
33143314
resolution: "@knide/fs-prober@workspace:package"
33153315
dependencies:
@@ -6174,6 +6174,7 @@ __metadata:
61746174
"@docusaurus/preset-classic": "npm:3.6.3"
61756175
"@docusaurus/tsconfig": "npm:3.6.3"
61766176
"@docusaurus/types": "npm:3.6.3"
6177+
"@knide/fs-prober": "npm:*"
61776178
"@mdx-js/react": "npm:^3.0.0"
61786179
clsx: "npm:^2.0.0"
61796180
prism-react-renderer: "npm:^2.3.0"

0 commit comments

Comments
 (0)