SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before installing this plugin, you must ensure that
tidy is installed on your system.
Mac OS X –
tidycomes preinstalled on recent versions of Mac OS X. You can install a more recent stable version by using Homebrew and
brew install homebrew/dupes/tidy. The experimental html5 version can be installed with
brew install homebrew/dupes/tidy --HEADor built and installed from source.
Linux – You should be able to install tidy using the system’s package manager. For example, on systems which use APT (such as Debian or its derivations), tidy can be installed with
sudo apt-get install tidy. The experimental html5 version can be built and installed from source.
In order for
tidy to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
tidy is installed and configured, you can proceed to install the SublimeLinter-tidy plugin if it is not yet installed.
Please use Package Control to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won’t cover that here.
To install via Package Control, do the following:
Within Sublime Text, bring up the Command Palette and type
install. Among the commands you should see
Package Control: Install Package. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins.
When the plugin list appears, type
html-tidy. Among the entries you should see
SublimeLinter-html-tidy. If that entry is not highlighted, use the keyboard or mouse to select it.
tidy must be configured via command line arguments. You can use the
"args" linter setting to pass arguments to tidy.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- Be patient. ;-)
Please note that modications should follow these coding guidelines:
- Indent is 4 spaces.
- Code should pass flake8 and pep257 linters.
- Vertical whitespace helps readability, don’t be afraid to use it.
Thank you for helping out!