From c0be3a374b6ebc42c895f45310d2b0677de823b9 Mon Sep 17 00:00:00 2001 From: deathaxe Date: Wed, 8 May 2024 13:43:21 +0200 Subject: [PATCH] Update README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/README.md b/README.md index 67e0212..1b8be73 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,52 @@ For working with [Jekyll](https://jekyllrb.com), this package also provides prop ![](preview.png) +## Installation + +### Package Control + +The easiest way to install is using [Package Control](https://packagecontrol.io). It's listed as `Liquid`. + +1. Open `Command Palette` using ctrl+shift+P or menu item `Tools → Command Palette...` +2. Choose `Package Control: Install Package` +3. Find `Liquid` and hit Enter + +### Manual Install + +1. Download appropriate [Liquid-2.0.0-st4xxx.sublime-package](https://github.com/SublimeText/Liquid/releases) for your Sublime Text build. + _The `st4xxx` suffix denotes the least required ST build for the sublime-package to work._ +2. Rename it to _Liquid.sublime-package_ +3. Copy it into _Installed Packages_ directory + +> To find _Installed Packages_... +> +> 1. call _Menu > Preferences > Browse Packages.._ +> 2. Navigate to parent folder + ## Usage To enable the syntax, select `Liquid > HTML (Liquid)` or `Liquid > Markdown (Liquid)` from syntax selection menu or via Command Palette. To always open your templates with this syntax, use the `Open all with current extension as ...` option, and select the proper Liquid syntax. + +## Troubleshooting + +Liquid extends Sublime Text's HTML, Markdown, CSS and JavaScript, syntax definitions. + +If Liquid syntax highlighting doesn't work and console displays syntax errors, + +1. check if required bundled packages are enabled. +2. remove any out-dated syntax override. + +### Enable bundled packages + +1. Open `Command Palette` using ctrl+shift+P or menu item `Tools → Command Palette...` +2. Choose `Package Control: Enable Packages` +3. Find `CSS` and hit Enter +4. Repeat the steps for `JavaScript`, `HTML` and `Markdown` + +### Remove overrides + +1. call _Menu > Preferences > Browse Packages.._ +2. Look for _CSS_, _HTML_, _JavaScript_, _Markdown_ folder +3. Remove them or at least delete any syntax definition in them