Skip to content

Commit

Permalink
docs(@vben/docs): add public static resources path documentation (#4788)
Browse files Browse the repository at this point in the history
  • Loading branch information
chengjm committed Nov 4, 2024
1 parent 35eef33 commit ebf247f
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/src/en/guide/essentials/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@ To run the `docs` application:
pnpm dev:docs
```

## Public Static Resources

If you need to use public static resources in the project, such as images, static HTML, etc., and you want to directly import them in the development process through `src="/xxx.png"`.

You need to put the resource in the corresponding project's `public/static` directory. The import path for the resource should be `src="/static/xxx.png"`.

## DevTools

The project has a built-in [Vue DevTools](https://github.com/vuejs/devtools-next) plugin, which can be used during development. It is disabled by default, but can be enabled in the `.env.development` file. After enabling it, restart the project:
Expand Down
6 changes: 6 additions & 0 deletions docs/src/guide/essentials/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,12 @@ pnpm dev:ele
pnpm dev:docs
```

## 公共静态资源

项目中需要使用到的公共静态资源,如:图片、静态HTML等,需要在开发中通过 `src="/xxx.png"` 直接引入的。

需要将资源放在对应项目的 `public/static` 目录下。引入的路径为:`src="/static/xxx.png"`

## DevTools

项目内置了 [Vue DevTools](https://github.com/vuejs/devtools-next) 插件,可以在开发过程中使用。默认关闭,可在`.env.development` 内开启,并重新运行项目即可:
Expand Down

0 comments on commit ebf247f

Please sign in to comment.