Skip to content

Commit c0be3a3

Browse files
author
deathaxe
committed
Update README
1 parent 7f15d92 commit c0be3a3

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

README.md

+44
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,52 @@ For working with [Jekyll](https://jekyllrb.com), this package also provides prop
66

77
![](preview.png)
88

9+
## Installation
10+
11+
### Package Control
12+
13+
The easiest way to install is using [Package Control](https://packagecontrol.io). It's listed as `Liquid`.
14+
15+
1. Open `Command Palette` using <kbd>ctrl+shift+P</kbd> or menu item `Tools → Command Palette...`
16+
2. Choose `Package Control: Install Package`
17+
3. Find `Liquid` and hit <kbd>Enter</kbd>
18+
19+
### Manual Install
20+
21+
1. Download appropriate [Liquid-2.0.0-st4xxx.sublime-package](https://github.com/SublimeText/Liquid/releases) for your Sublime Text build.
22+
_The `st4xxx` suffix denotes the least required ST build for the sublime-package to work._
23+
2. Rename it to _Liquid.sublime-package_
24+
3. Copy it into _Installed Packages_ directory
25+
26+
> To find _Installed Packages_...
27+
>
28+
> 1. call _Menu > Preferences > Browse Packages.._
29+
> 2. Navigate to parent folder
30+
931
## Usage
1032

1133
To enable the syntax, select `Liquid > HTML (Liquid)` or `Liquid > Markdown (Liquid)` from syntax selection menu or via Command Palette.
1234

1335
To always open your templates with this syntax, use the `Open all with current extension as ...` option, and select the proper Liquid syntax.
36+
37+
## Troubleshooting
38+
39+
Liquid extends Sublime Text's HTML, Markdown, CSS and JavaScript, syntax definitions.
40+
41+
If Liquid syntax highlighting doesn't work and console displays syntax errors,
42+
43+
1. check if required bundled packages are enabled.
44+
2. remove any out-dated syntax override.
45+
46+
### Enable bundled packages
47+
48+
1. Open `Command Palette` using <kbd>ctrl+shift+P</kbd> or menu item `Tools → Command Palette...`
49+
2. Choose `Package Control: Enable Packages`
50+
3. Find `CSS` and hit <kbd>Enter</kbd>
51+
4. Repeat the steps for `JavaScript`, `HTML` and `Markdown`
52+
53+
### Remove overrides
54+
55+
1. call _Menu > Preferences > Browse Packages.._
56+
2. Look for _CSS_, _HTML_, _JavaScript_, _Markdown_ folder
57+
3. Remove them or at least delete any syntax definition in them

0 commit comments

Comments
 (0)