Skip to content

Commit 7c8a18e

Browse files
committed
feat(docs): update development guide and fix docs build scripts
- Add development guide with pnpm commands to README.md - Fix docs build scripts in docs/package.json - Update opencollective username in .github/FUNDING.yml
1 parent deab2cf commit 7c8a18e

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

.github/FUNDING.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
github: [ryanuo]
2-
opencollective: ryan55
2+
opencollective: ryanuo

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ Below are the module categories available in the utility library:
8181
| [Node](https://utils.ryanuo.cc/api/node/) | [logger()](https://utils.ryanuo.cc/api/node/variables/logger.html)[mkdirp()](https://utils.ryanuo.cc/api/node/functions/mkdirp.html)[rmrf()](https://utils.ryanuo.cc/api/node/functions/rmrf.html) |
8282
<!-- auto utils end -->
8383

84+
## How to development
85+
86+
```bash
87+
pnpm i
88+
pnpm dev
89+
pnpm build
90+
91+
# docs
92+
cd docs
93+
pnpm run predocs:dev
94+
```
95+
8496
## License
8597

8698
[MIT](https://github.com/ryanuo/utils/blob/main/LICENSE) License © 2023-PRESENT [ryanuo](https://github.com/ryanuo)

docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
"scripts": {
66
"predocs:dev": "typedoc && pnpm run docs:fix",
77
"docs:dev": "vitepress dev",
8-
"docs:build": "pnpm add @ryanuo/utils@latest --no-lockfile -D && vitepress build",
9-
"docs:dev-build": "vitepress build",
8+
"docs:build": "pnpm add @ryanuo/utils@latest --no-lockfile -D && pnpm run docs:dev-build",
9+
"docs:dev-build": "pnpm run predocs:dev && vitepress build",
1010
"docs:preview": "vitepress preview",
1111
"docs:fix": "npx eslint --fix .",
1212
"update": "pnpm run predocs:dev && cd ../ && pnpm run readme"

0 commit comments

Comments
 (0)