Skip to content

Commit 2d42c49

Browse files
committed
docs(readme): use conventional markup alert
1 parent ca1b6d8 commit 2d42c49

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Then [import](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modu
1414
```javascript
1515
import { Util, ILog } from '@ceeblue/web-utils';
1616
```
17-
> 💡 **TIP**
17+
> [!IMPORTANT]
1818
>
1919
> If your project uses TypeScript, it is recommended that you set target: "ES6" in your configuration to match our use of ES6 features and ensure that your build will succeed (for those requiring a backward-compatible UMD version, a local build is recommended).
2020
> Then define the "moduleResolution" compiler option: "Node" in tsconfig.json helps with import failures by ensuring that TypeScript uses the correct import resolution strategy based on the targeted Node.js version.
@@ -27,7 +27,7 @@ import { Util, ILog } from '@ceeblue/web-utils';
2727
> }
2828
> ```
2929
30-
> ⚠️ **REMARKS**
30+
> [!TIP]
3131
>
3232
> To debug production code without modifying it, the library can use special query parameter of the main page's URL:
3333
> - __!cb-override-log-level__ : allows to override the log level for the entire library, see [Log.ts](./src/Log.ts) for details on handling log levels.
@@ -59,7 +59,7 @@ npm run build:docs
5959
6060
Once generated, open the `index.html` file located in the `docs` folder (`./docs/index.html`) with your browser.
6161
62-
> 📌 **NOTE**
62+
> [!NOTE]
6363
>
6464
> An online, continuously maintained version of the latest released documentation is available at https://ceebluetv.github.io/web-utils/
6565

0 commit comments

Comments
 (0)