Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
SublimeLinter 3 plugin for html tidy.
Python
branch: master

Added instructions to install tidy-html5 for Mac OS X with brew

Mostly derived from PR #23, with a few edits
latest commit 6cf77fc68e
@Aedx Aedx authored

README.md

SublimeLinter-html-tidy

Build Status

This linter plugin for SublimeLinter provides an interface to tidy (either the html4 or html5 version). It will be used with files that have the “HTML” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that tidy is installed on your system.

  • Mac OS Xtidy comes 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 --HEAD or 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.

  • Windows – Windows binaries are available for both the stable, and experimental html5 versions.

Linter configuration

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.

Once tidy is installed and configured, you can proceed to install the SublimeLinter-tidy plugin if it is not yet installed.

Plugin installation

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:

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

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

Settings

For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.

tidy must be configured via command line arguments. You can use the "args" linter setting to pass arguments to tidy.

Contributing

If you would like to contribute enhancements or fixes, please do the following:

  1. Fork the plugin repository.
  2. Hack on a separate topic branch created from the latest master.
  3. Commit and push the topic branch.
  4. Make a pull request.
  5. 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!

Something went wrong with that request. Please try again.