Skip to content

Commit 3c8313d

Browse files
authored
Fix links and formatting in README.md
Updated links in the README to use HTTPS and corrected some formatting issues.
1 parent 22560ab commit 3c8313d

File tree

1 file changed

+11
-27
lines changed

1 file changed

+11
-27
lines changed

README.md

Lines changed: 11 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,7 @@
77
<h4 align="center">A SublimeLinter plugin for HTML, using HTMLHint.</h4>
88

99
<p align="center">
10-
<a href="https://travis-ci.org/htmlhint/SublimeLinter-contrib-htmlhint">
11-
<img src="https://img.shields.io/travis/htmlhint/SublimeLinter-contrib-htmlhint.svg" alt="Travis Build Status">
12-
</a>
13-
<a href="https://codecov.io/gh/htmlhint/SublimeLinter-contrib-htmlhint">
14-
<img src="https://codecov.io/gh/htmlhint/SublimeLinter-contrib-htmlhint/branch/master/graph/badge.svg" alt="Codecov">
15-
</a>
16-
<a href="https://www.npmjs.com/package/SublimeLinter-contrib-htmlhint">
17-
<img src="https://img.shields.io/npm/dm/SublimeLinter-contrib-htmlhint.svg" alt="NPM count">
18-
</a>
19-
<img src="https://badgen.net/badge/license/MIT/green" alt="MIT Licence" />
20-
<a href="https://discord.gg/nJ6J9CP">
21-
<img src="https://img.shields.io/badge/chat-on%20discord-7289da.svg" alt="Chat">
22-
</a>
23-
</p>
24-
25-
<p align="center">
26-
  <a href="#install">How To Use</a> • <a href="/CONTRIBUTING.md">Contributing</a> • <a href="https://htmlhint.com">Website</a>
10+
  <a href="#install">How To Use</a> • <a href="/CONTRIBUTING.md">Contributing</a> • <a href="https://htmlhint.com">Website</a>
2711
</p>
2812

2913
## Table of Contents
@@ -35,7 +19,7 @@ This linter plugin for [SublimeLinter][docs] provides an interface to [HTMLHint]
3519

3620
## Install
3721

38-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](http://www.sublimelinter.com/en/stable/installation.html).
22+
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please [follow the instructions](https://www.sublimelinter.com/en/stable/installation.html).
3923

4024
### Linter installation
4125

@@ -59,7 +43,7 @@ Or install `htmlhint` locally in your project folder (**you must have package.js
5943

6044
### Linter configuration
6145

62-
In order for `htmlhint` 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”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
46+
In order for `htmlhint` 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”](https://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.
6347

6448
Once you have installed and configured `htmlhint`, you can proceed to install the SublimeLinter-contrib-htmlhint plugin if it is not yet installed.
6549

@@ -77,7 +61,7 @@ To install via Package Control, do the following:
7761

7862
For general information on how SublimeLinter works with settings, please see [Settings][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings].
7963

80-
You can configure `htmlhint` options in the way you would from the command line, with `.htmlhintrc` files. For more information, see the [htmlhintrc docs](https://github.com/yaniswang/HTMLHint/wiki/Rules). The linter plugin does this by searching for a `.htmlhintrc` file itself, just as `htmlhint` does from the command line. You may provide a custom config file by setting the linter’s `"args"` setting to `["--config", "/path/to/file"]`. On Windows, be sure to double the backslashes in the path, for example `["--config", "C:\\Users\\Username\\htmlhint.conf"]`.
64+
You can configure `htmlhint` options in the way you would from the command line, with `.htmlhintrc` files. For more information, see the [htmlhintrc docs](https://htmlhint.com/rules/). The linter plugin does this by searching for a `.htmlhintrc` file itself, just as `htmlhint` does from the command line. You may provide a custom config file by setting the linter’s `"args"` setting to `["--config", "/path/to/file"]`. On Windows, be sure to double the backslashes in the path, for example `["--config", "C:\\Users\\Username\\htmlhint.conf"]`.
8165

8266
The path to the `.htmlhintrc` file is cached, meaning if you create a new `.htmlhintrc` that should have precedence over the previous one (meaning it is closer to the .js file) you need to clear the cache for the linter to use the new `.htmlhintrc` You can clear the cache by going to: Tools > SublimeLinter > Clear Caches.
8367

@@ -89,11 +73,11 @@ Project initially created by [@mmaday](https://github.com/mmaday) and transferre
8973

9074
[MIT License](./LICENSE)
9175

92-
[docs]: http://sublimelinter.readthedocs.org
93-
[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html
94-
[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located
76+
[docs]: https://sublimelinter.readthedocs.org
77+
[installation]: https://sublimelinter.readthedocs.io/en/latest/installation.html
78+
[locating-executables]: https://sublimelinter.readthedocs.io/en/latest/usage.html#how-linter-executables-are-located
9579
[pc]: https://sublime.wbond.net/installation
96-
[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html
97-
[settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html
98-
[linter-settings]: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
99-
[inline-settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings
80+
[cmd]: https://www.docs.sublimetext.info/index.html
81+
[settings]: https://sublimelinter.readthedocs.io/en/latest/settings.html
82+
[linter-settings]: https://sublimelinter.readthedocs.io/en/latest/linter_settings.html
83+
[inline-settings]: https://sublimelinter.readthedocs.io/en/latest/settings.html#inline-settings

0 commit comments

Comments
 (0)