Skip to content

Commit da5f5ec

Browse files
committed
docs(usage): add missing management commands documentation
- Add config command for displaying current configuration - Add setup command for interactive project setup guide - Add troubleshoot command for debugging common issues - Add optimize command for performance optimization tips - Reorganize command order to match help output sequence
1 parent a3f21cc commit da5f5ec

File tree

1 file changed

+62
-10
lines changed

1 file changed

+62
-10
lines changed

docs/usage.md

Lines changed: 62 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -19,17 +19,9 @@ hide:
1919

2020
Run `python manage.py tailwind build` to create an optimized production built of the stylesheet. Afterwards you are ready to deploy. Take care the this command is run before `python manage.py collectstatic` in your build process.
2121

22-
### download_cli
23-
24-
Run `python manage.py tailwind download_cli` to just download the CLI. This commands downloads the correct version of the CLI for your platform and stores it in the path configured by the `TAILWIND_CLI_PATH` setting.
25-
26-
### list_templates
27-
28-
Run `python manage.py tailwind list_templates` to find all templates in your django project. This is handy for a setup where you dynamically build the list of files being analyzed by tailwindcss.
29-
30-
### remove_cli
22+
### watch
3123

32-
Run `python manage.py tailwind remove_cli` to remove the installed cli.
24+
Run `python manage.py tailwind watch` to just start a tailwind watcher process if you prefer to start your debug server in a seperate shell or prefer a different solution than runserver or runserver_plus.
3325

3426
### runserver
3527

@@ -83,6 +75,66 @@ Options:
8375
--help Show this message and exit.
8476
```
8577
78+
### list_templates
79+
80+
Run `python manage.py tailwind list_templates` to find all templates in your django project. This is handy for a setup where you dynamically build the list of files being analyzed by tailwindcss.
81+
82+
### download_cli
83+
84+
Run `python manage.py tailwind download_cli` to just download the CLI. This commands downloads the correct version of the CLI for your platform and stores it in the path configured by the `TAILWIND_CLI_PATH` setting.
85+
86+
### config
87+
88+
Run `python manage.py tailwind config` to show current Tailwind CSS configuration. This command displays the current configuration settings and their values, helping you understand how django-tailwind-cli is configured in your project.
89+
90+
The command shows:
91+
- All configuration paths (CLI, CSS input/output)
92+
- Version information
93+
- Django settings values
94+
- File existence status
95+
- Platform information
96+
97+
### setup
98+
99+
Run `python manage.py tailwind setup` to launch the interactive setup guide for django-tailwind-cli. This command provides step-by-step guidance for setting up Tailwind CSS in your Django project, from installation to first build.
100+
101+
The guide covers:
102+
1. Installation verification
103+
2. Django settings configuration
104+
3. CLI binary download
105+
4. First CSS build
106+
5. Template integration
107+
6. Development workflow
108+
109+
This is perfect for first-time setup, troubleshooting configuration issues, or learning the development workflow.
110+
111+
### troubleshoot
112+
113+
Run `python manage.py tailwind troubleshoot` to access the troubleshooting guide for common issues. This command provides solutions for the most common issues encountered when using django-tailwind-cli, with step-by-step debugging guidance.
114+
115+
Common issues covered:
116+
- CSS not updating in browser
117+
- Build failures and errors
118+
- Missing or incorrect configuration
119+
- Permission and download issues
120+
- Template integration problems
121+
122+
### optimize
123+
124+
Run `python manage.py tailwind optimize` to view performance optimization tips and best practices. This command provides detailed guidance on optimizing your Tailwind CSS build performance and development workflow for the best possible experience.
125+
126+
Areas covered:
127+
- Build performance optimization
128+
- File watching efficiency
129+
- Template scanning optimization
130+
- Production deployment best practices
131+
- Development workflow improvements
132+
- Common performance pitfalls
133+
134+
### remove_cli
135+
136+
Run `python manage.py tailwind remove_cli` to remove the installed cli.
137+
86138
### watch
87139
88140
Run `python manage.py tailwind watch` to just start a tailwind watcher process if you prefer to start your debug server in a seperate shell or prefer a different solution than runserver or runserver_plus.

0 commit comments

Comments
 (0)