You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-14Lines changed: 15 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,8 +9,6 @@
9
9
10
10
The ultimate **ExpressionEngine CMS** extension for Visual Studio Code <br> with scaffolding commands to generate add-ons and template files, syntax highlighting, snippets and IntelliSense.
11
11
12
-
<br>
13
-
14
12
### Generate Add-ons
15
13
16
14
@@ -23,16 +21,8 @@ The ultimate **ExpressionEngine CMS** extension for Visual Studio Code <br> with
23
21
</div>
24
22
25
23
## Getting Started
26
-
Make sure to update your user **settings.json** to include the extensions language identifier for both ExpressionEngine and HTML files so that Emmet can autocomplete properly.
27
24
28
-
```javascript
29
-
"emmet.includeLanguages": {
30
-
"ee":"html"
31
-
}
32
-
```
33
-
34
-
## Setup ExpressionEngine Paths
35
-
By default, this extension assumes the directory to your add-ons and template files will be based on a fresh install of an ExpressionEngine site.
25
+
**Step 1:** Setup your ExpressionEngine paths. By default, this extension assumes the directory to your add-ons and template files will be based on a fresh install of an ExpressionEngine site.
36
26
37
27
**Example:**`<project-directory>/system/user/**`
38
28
@@ -44,7 +34,16 @@ If you have changed your projects directory structure you have the option to ove
44
34
45
35
The above example would resolve to something like: `/Users/your-name/sites/my-site/system/user`
46
36
47
-
**Note:** Only one workspace is supported at this time.
37
+
📘**Note:** Only one workspace is supported at this time. In order to run commands properly, you will need to open additional sites within seperate windows.
38
+
39
+
40
+
**Step 2:** Make sure to update your user **settings.json** to include the extensions language identifier for both ExpressionEngine and HTML files so that Emmet can autocomplete properly.
41
+
42
+
```javascript
43
+
"emmet.includeLanguages": {
44
+
"ee":"html"
45
+
}
46
+
```
48
47
49
48
## Commands
50
49
All commands start within the `EE` namespace. Visual Studio Code will however correctly pull up the commands even if you type it in lowercase. Also, while the full name of the commands appears long, the editor will match shorter typings like `ee addon-on`, `ee partial` etc.
@@ -56,11 +55,13 @@ All commands start within the `EE` namespace. Visual Studio Code will however co
56
55
<sub>EE: Create Template Variable</sub> | <sub>Input requesting a template variable name. Outputs to your `_variables` directory.</sub>|
57
56
<sub>EE: Create Template Partial</sub>| <sub>Input requesting a template partial name. Outputs to your `_partials` directory.</sub>|
58
57
58
+
<br>
59
+
59
60
60
-
**Note:**
61
+
📘**Note:**
61
62
When creating template variables or partials you can omit the `.html` extension as this will be automatically appended for you. You only need to provide a name that matches the allowed characters.
62
63
63
-
**Known Limitations:**
64
+
🔺**Known Limitations:**
64
65
After creating either a template, variable or partial you can still delete it from the sidebar tree in your editor as long as you don't refresh your local site either in the Control Panel or the front-end as this will cause EE to pull the latest files and sync to the database. The best option for deleting or renaming your files is likely best done within the Control Panel.
0 commit comments