Skip to content

Commit adbbb1d

Browse files
authored
docs: update note in README.md (#138)
1 parent 8c4ad54 commit adbbb1d

File tree

1 file changed

+21
-7
lines changed

1 file changed

+21
-7
lines changed

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,13 @@ The imports loader can add the necessary `require('whatever')` calls, so those m
2121

2222
For further hints on compatibility issues, check out [Shimming](https://webpack.js.org/guides/shimming/) of the official docs.
2323

24-
> ⚠ By default loader generate ES module named syntax.
24+
> **Warning**
25+
>
26+
> By default loader generate ES module named syntax.
2527
26-
> ⚠ Be careful, existing imports (`import`/`require`) in the original code and importing new values can cause failure.
28+
> **Warning**
29+
>
30+
> Be careful, existing imports (`import`/`require`) in the original code and importing new values can cause failure.
2731
2832
## Getting Started
2933

@@ -60,7 +64,9 @@ Then you can inject the `jquery` value into the module by configuring the `impor
6064
The `|` or `%20` (space) allow to separate the `syntax`, `moduleName`, `name` and `alias` of import.
6165
The documentation and syntax examples can be read [here](#syntax).
6266

63-
> `%20` is space in a query string, because you can't use spaces in URLs
67+
> **Warning**
68+
>
69+
> `%20` is space in a query string, because you can't use spaces in URLs
6470
6571
```js
6672
// Alternative syntax:
@@ -358,9 +364,13 @@ If type `commonjs`:
358364
- `[multiple Foo FooA Bar]` - generates `const { FooA: Bar } = require("Foo");`.
359365
- `[pure Foo]` - generates `require("Foo");`.
360366

361-
> ⚠ You need to set `type: "commonjs"` to use `single`, `multiple` and `pure` syntaxes.
367+
> **Warning**
368+
>
369+
> You need to set `type: "commonjs"` to use `single`, `multiple` and `pure` syntaxes.
362370
363-
> ⚠ Aliases can't be used together with `default`, `namespace`, `side-effects`, `single` and `pure` syntaxes.
371+
> **Warning**
372+
>
373+
> Aliases can't be used together with `default`, `namespace`, `side-effects`, `single` and `pure` syntaxes.
364374
365375
###### Examples
366376

@@ -440,7 +450,9 @@ Properties:
440450
- `name` - name of an imported value (**required**)
441451
- `alias` - alias of an imported value (**may be omitted**)
442452

443-
> ⚠ Alias can't be used together with `default`, `namespace`, `side-effects`, `single` and `pure` syntaxes.
453+
> **Warning**
454+
>
455+
> Alias can't be used together with `default`, `namespace`, `side-effects`, `single` and `pure` syntaxes.
444456
445457
##### Examples
446458

@@ -557,7 +569,9 @@ Default: `undefined`
557569

558570
Closes the module code in a function with a given `thisArg` and `args` (`(function () { ... }).call();`).
559571

560-
> ⚠ Do not use this option if source code contains ES module import(s)
572+
> **Warning**
573+
>
574+
> Do not use this option if source code contains ES module import(s)
561575
562576
#### `boolean`
563577

0 commit comments

Comments
 (0)