Home Explore Help
Register Sign In
oleg
/
alpine
mirror of https://github.com/alpinejs/alpine.git
1
0
Fork 0
Files Issues 0 Wiki
Browse Source

update CSP build/installation docs (#3762)

there has been a lot of confusion on how to use the CSP build, so this commit hopefully clears them up, and provides more explicit instructions on how to "build from source".

some of the wording and code examples make it seem like an NPM package is available, so we'll update that to avoid confusion.

Co-authored-by: Caleb Porzio <calebporzio@gmail.com>
Andrew Brown 1 year ago
parent
1e72dfb22e
commit
b124ed7ffe
1 changed files with 10 additions and 3 deletions
Unified View Show Diff Stats
  1. 10 3
      packages/docs/src/en/advanced/csp.md

+ 10 - 3
packages/docs/src/en/advanced/csp.md
View File 

@@ -14,14 +14,21 @@ In order to accommodate environments where this CSP is necessary, Alpine will of
 
 <a name="installation"></a>
 
 <a name="installation"></a>
 
 ## Installation
 
 ## Installation
 
 
 
-The CSP build hasn't been officially released yet. In the meantime, you may [build it from source](https://github.com/alpinejs/alpine/tree/main/packages/csp). Once released, like all Alpine extensions, you will be able to include this either via `<script>` tag or module import:
 
+The CSP build hasn’t been officially released yet. In the meantime, you may build it from source. To do this, clone the [`alpinejs/alpine`](https://github.com/alpinejs/alpine) repository and run:
 
+
 
+```shell
 
+npm install
 
+npm run build
 
+```
 
+
 
+This will generate a `/packages/csp/dist/` directory with the built files. After copying the appropriate file into your project, you can include it either via `<script>` tag or module import:
 
 
 
 <a name="script-tag"></a>
 
 <a name="script-tag"></a>
 
 ### Script tag
 
 ### Script tag
 
 
 
 ```alpine
 
 ```alpine
 
 <html>
 
 <html>
 
-    <script src="alpinejs/alpinejs-csp/cdn.js" defer></script>
 
+    <script src="/path/to/cdn.js" defer></script>
 
 </html>
 
 </html>
 
 ```
 
 ```
 
 
 
@@ -29,7 +36,7 @@ The CSP build hasn't been officially released yet. In the meantime, you may [bui
 
 ### Module import
 
 ### Module import
 
 
 
 ```js
 
 ```js
 
-import Alpine from '@alpinejs/csp'
 
+import Alpine from './path/to/module.esm.js'
 
 
 
 window.Alpine = Alpine
 
 window.Alpine = Alpine
 
 window.Alpine.start()
 
 window.Alpine.start()