Added docs link to note on Tailwind configuration. (#145)

django-crispy-forms · Jan 4, 2024 · 4422619 · 4422619
1 parent 1dfc341
commit 4422619
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 1 deletion.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -9,7 +9,7 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ammaraskar/sphinx-action@master
       with:
         docs-folder: "docs/"
diff --git a/docs/getting_started.txt b/docs/getting_started.txt
@@ -25,6 +25,15 @@ your project::
 
     CRISPY_TEMPLATE_PACK = "tailwind"
 
+If you use `Tailwind CLI <https://tailwindcss.com/docs/installation>`_, you have to provide the path to your
+templates. Since this package contains templates which are within your Pythons `site-packages`, it's hard to tell
+Tailwind where these templates live.
+
+Thanks to Carlton Gibson's blog, you can implement (aka copy & paste) a Django management command and the corresponding
+Tailwind configuration:
+
+https://noumenal.es/notes/tailwind/django-integration/
+
 Usage
 =====
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 sphinx-rtd-theme
+docutils<0.21,>=0.18.1