Skip to content

Commit 64e37e9

Browse files
Update README.md
- Improve documentation organization
1 parent 295c282 commit 64e37e9

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@
99

1010
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.
1111

12-
<br>
13-
1412
### Generate Add-ons
1513

1614

@@ -23,16 +21,8 @@ The ultimate **ExpressionEngine CMS** extension for Visual Studio Code <br> with
2321
</div>
2422

2523
## 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.
2724

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.
3626

3727
**Example:** `<project-directory>/system/user/**`
3828

@@ -44,7 +34,16 @@ If you have changed your projects directory structure you have the option to ove
4434

4535
The above example would resolve to something like: `/Users/your-name/sites/my-site/system/user`
4636

47-
**Note:** Only one workspace is supported at this time.
37+
&#x1F4D8; **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+
```
4847

4948
## Commands
5049
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
5655
<sub>EE: Create Template Variable</sub> | <sub>Input requesting a template variable name. Outputs to your `_variables` directory.</sub>|
5756
<sub>EE: Create Template Partial</sub>| <sub>Input requesting a template partial name. Outputs to your `_partials` directory.</sub>|
5857

58+
<br>
59+
5960

60-
**Note:**
61+
&#x1F4D8; **Note:**
6162
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.
6263

63-
**Known Limitations:**
64+
&#x1F53A; **Known Limitations:**
6465
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.
6566

6667
## Customizing Colors

0 commit comments

Comments
 (0)