Skip to content

Commit 38b58af

Browse files
committed
docs: add clearer note formatting
1 parent 1fb3f3b commit 38b58af

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ dependencies:
3535

3636
3. Run `yarn add -D vite vite-plugin-lucky` to install Vite and the plugin for Lucky
3737

38-
**Note**: Look at [vite-plugin-lucky](https://github.com/wout/vite-plugin-lucky) for more info about the plugin.
38+
> [!Note]
39+
> Look at [vite-plugin-lucky](https://github.com/wout/vite-plugin-lucky) for more info about the plugin.
3940

4041
## Setup
4142

@@ -50,7 +51,8 @@ Run **`bin/lucky_vite init`** to create the following files:
5051
- `src/js/entry/main.js`: the first entry point with a basic setup
5152
- `src/css/main.css`: an empty stylesheet which is referenced by `main.js`
5253

53-
**Note**: The initializer accepts a name option for the entry script: `bin/lucky_vite init --name=app`.
54+
> [!Note]
55+
> The initializer accepts a name option for the entry script: `bin/lucky_vite init --name=app`.
5456

5557
### 2. Load the Vite manifest
5658

@@ -61,7 +63,8 @@ Replace the `Lucky::AssetHelpers.load_manifest` line in `src/app.cr` with:
6163
+LuckyVite::AssetHelpers.load_manifest
6264
```
6365

64-
**Note**: The `load_manifest` macro optionally takes a path to the `lucky_vite.json` config.
66+
> [!Note]
67+
> The `load_manifest` macro optionally takes a path to the `lucky_vite.json` config.
6568

6669
### 3. Register the Vite processes
6770

@@ -162,7 +165,8 @@ vite_css_links "main.js"
162165

163166
Together they do the exact same thing as `vite_entry_tags`.
164167

165-
**Note**: the `vite_css_links` macro takes the main JS entry point as an argument, because that's where the CSS is imported. This macro will only generate output in production.
168+
> [!Note]
169+
> The `vite_css_links` macro takes the main JS entry point as an argument, because that's where the CSS is imported. This macro will only generate output in production.
166170

167171
#### Full control
168172

@@ -194,7 +198,8 @@ LuckyVite manages the asset pipeline by overwriting Lucky's `asset` and `dynamic
194198
img src: asset("@images/logo.png")
195199
```
196200

197-
**Note**: The asset helper uses Vite's aliases for easier referencing. Aliases can be configured in `config/lucky_vite.json`.
201+
> [!Note]
202+
> The asset helper uses Vite's aliases for easier referencing. Aliases can be configured in `config/lucky_vite.json`.
198203

199204
## Configuration
200205

@@ -233,7 +238,8 @@ Here's a bit more info about the available properties:
233238
- **`origin`** (_`string`_): alternative to using `https`, `host` and `port`
234239
- _example_: `"http://localhost:3210"`
235240

236-
**Note**: Not all Vite's configuration options are recognised here as this file covers that's shared between Vite and Lucky. You can add other Vite-specific configuration options directly in `vite.config.js`.
241+
> [!Note]
242+
> Not all Vite's configuration options are recognised here as this file covers that's shared between Vite and Lucky. You can add other Vite-specific configuration options directly in `vite.config.js`.
237243

238244
## Documentation
239245

0 commit comments

Comments
 (0)