@@ -7,29 +7,44 @@ Built with JinjaX, Alpine.js, and Tailwind CSS, with support for htmx.
77
88### Quick Start with ` uvx `
99
10- You can use the CLI directly without installing the package:
10+ JinjaX is required.
11+
12+ ``` bash
13+ # install jinjax
14+ uvx add jinjax
15+ ````
16+
17+ You can use the CLI directly without installing the package.
1118
1219` ` ` bash
1320# Add components
1421uvx --from basic-components components add button
1522` ` `
1623
1724You will also need to configure your project to load components into the ` jinjax.Catalog` and add a global ` cn` function
18- to the Jinja environment. See [ utilities] ( docs/content/docs/utilities.md )
25+ to the Jinja environment. See [utilities](https://components.basicmachines.co/docs/utilities).
26+
27+ Helpers for these are packed in the ` basic-components[utils]` package.
1928
2029# ## Package Installation Options
2130
22- Install only the utility functions for JinjaX and tailwind:
31+ Install only the utility functions for JinjaX and tailwind.
2332
2433` ` ` bash
2534# With utility functions
2635pip install basic-components[utils]
2736` ` `
2837
38+ Setup instructions and examples:
39+ - [FastAPI](https://components.basicmachines.co/docs/fastapi)
40+ - [Flask](https://components.basicmachines.co/docs/flask)
41+ - [Django](https://components.basicmachines.co/docs/django)
42+
43+
2944# ## Installation Groups
3045
3146- ` utils` : Utility functions for JinjaX setup and `cn ()` tailwind class helper
32- - ` docs ` : Runs the docs site
47+ - ` docs` : Requirements for the docs site
3348- ` dev` : Development tools for contributing
3449- ` full` : All features included
3550
@@ -51,7 +66,7 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
5166
5267- [x] accordion
5368- [x] alert
54- - [x] alert-dialog -- example cancel/action
69+ - [x] alert-dialog
5570- [ ] aspect-ratio
5671- [ ] avatar
5772- [x] badge
@@ -65,7 +80,7 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
6580- [ ] collapsible
6681- [ ] command
6782- [ ] context-menu
68- - [x] dialog -- examples
83+ - [x] dialog
6984- [ ] drawer
7085- [x] dropdown-menu
7186- [x] form
@@ -100,4 +115,4 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
100115- [ ] tooltip
101116
102117Extended
103- - [ ] Prose - https://docs.astro.build/en/recipes/tailwind-rendered-markdown/#recipe
118+ - [ ] Prose
0 commit comments