Skip to content

Commit

Permalink
chore: more doc updates for cli and utils functions
Browse files Browse the repository at this point in the history
  • Loading branch information
phernandez committed Nov 15, 2024
1 parent d481aef commit 5ad08fb
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/content/docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The components in this project can be copied (vendored) directly into your proje
in the `basic-components` package via `uv`. You can then customize them as needed. This is the recommendedd way to
install components because it will also include any dependencies (other referenced components) required.

To vendor a component into your project using the `components` tool:
To vendor a component into your project using the `components` tool, run

```bash
uvx --from basic-components add <component_name>
Expand Down
6 changes: 3 additions & 3 deletions docs/content/docs/utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@ description: Helper functions for setting up components and merging Tailwind cla

<Prose>

To use the utility function below, install the `basic-components` package into your project. You can also get the code
To use the utility functions below, install the `basic-components` package into your project. You can also get the code
from GitHub.

```bash
uv add basic-machines
uv add "basic-machines[utils]"
```

## JinjaX
Expand All @@ -18,7 +18,7 @@ uv add basic-machines

Components are organized into subdirectories by type (e.g., `accordion`, `button`, `dialog`).
This organization helps with maintenance but doesn't affect how you use the components in your templates. This allows
you to use components with their original names, without needing to reference the subdirectories:
you to use components with their original names, without needing to reference the subdirectories.

```html
<!-- Components can be used directly, no need for subdirectory prefixes -->
Expand Down

0 comments on commit 5ad08fb

Please sign in to comment.