Skip to content

Commit

Permalink
docs: add console
Browse files Browse the repository at this point in the history
  • Loading branch information
yjl9903 committed Oct 1, 2024
1 parent fe87081 commit 8ef28f2
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ Or if you did some advanced modification (see below), you can just copy and past

## Usage

`unplugin-info` creates several virtual modules, `~build/time`, `~build/git`, `~build/ci`, `~build/meta`, `~build/env`, and `~build/package`.
`unplugin-info` creates several virtual modules, `~build/time`, `~build/git`, `~build/ci`, `~build/console`, `~build/meta`, `~build/env`, and `~build/package`.

You can just import these modules as usual, and do anything with them. Common use cases may be like:

Expand Down Expand Up @@ -306,6 +306,14 @@ It exports the current CI/CD environment information, which is powered by [ci-in
import { isCI, isPR, name } from '~build/ci'
```

## ~build/console

It will print some helpful logs in your browser.

```ts
import '~build/console';
```

### ~build/meta

It exports some meta data from the options of the plugin.
Expand Down

0 comments on commit 8ef28f2

Please sign in to comment.