docs: update install-local-documentation.md
This commit is contained in:
1 parent
ddfb8ca513
commit
7825f563db
1 file changed
+13
-6
@@ -1,19 +1,26 @@
|
|||||||
# Manage Local Documentation
|
# Manage Local Documentation
|
||||||
|
|
||||||
Documents from `Vutron` can be viewed in the local environment through the VitePress viewer.
|
Documents from `Vutron` can be viewed in the local environment through the `VitePress` viewer.
|
||||||
|
|
||||||
This function works only when the entire project is cloned. If you created the project with `npm init`, the `docs` folder is not included.
|
This function works only when the entire project is cloned. If you created the project with `npm init vutron`, the `docs` folder is not included.
|
||||||
|
|
||||||
Since VitePress and related plugin packages are configured to be selectively installed, they cannot be installed with `npm i`.
|
## Installation
|
||||||
|
|
||||||
Install the relevant packages using the following preconfigured script commands:
|
Install the relevant packages using the following commands:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ npm run docs:install
|
# via npm
|
||||||
|
$ npm i
|
||||||
|
|
||||||
|
# via yarn (https://yarnpkg.com)
|
||||||
|
$ yarn install
|
||||||
|
|
||||||
|
# via pnpm (https://pnpm.io)
|
||||||
|
$ pnpm i
|
||||||
```
|
```
|
||||||
|
|
||||||
You can run the local server where the documents are hosted via the command below.
|
You can run the local server where the documents are hosted via the command below.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
$ npm run docs:dev
|
$ npm run dev
|
||||||
```
|
```
|
||||||
Reference in new issue
Block a user