Browse files

Docs: Update internal links to `.md` files

  • Loading branch information...
molant committed Nov 27, 2018
1 parent 970f386 commit 7f0d8994cb9ee6ead9c98e256efdeb067a861970
@@ -68,11 +68,11 @@ the most up-to-date diagram of the interaction:
<!-- Link labels: -->
[default configuration]: ../../user-guide/#default-configuration
[events]: ./events/
[new connector]: ../how-to/connector/
[new parser]: ../how-to/parser/
[new hint]: ../how-to/hint/
[default configuration]: ../../user-guide/
[events]: ./
[new connector]: ../how-to/
[new formatter]: ../how-to/
[new parser]: ../how-to/
[new hint]: ../how-to/
@@ -148,7 +148,7 @@ type ScanStart {
a `Promise` because it will not wait for it to be resolved. If you
need to perform an `async` operation you should combine it with
`scan::end`. You can find more information in [how to interact with
other services](../hints/
other services](../how-to/
## `traverse::down`
@@ -205,7 +205,7 @@ hintRunner.testHint(hintPath, tests, {
<!-- Link labels: -->
[browserconfiguration]: ../../../user-guide/configuring-webhint/browser-context/
[browserconfiguration]: ../../user-guide/configuring-webhint/
[new issue]:
[parsers]: ../../../user-guide/concepts/parsers/
[parsers]: ../../user-guide/concepts/
[ssllabs code]:
@@ -132,8 +132,8 @@ following tests:
[depth-first search]:
[iconnector interface]:
[events]: ../getting-started/events/
[events]: ../getting-started/
[events scanstart]: ../getting-started/
[events fetchstart]: ../getting-started/
[events fetcherror]: ../getting-started/
@@ -67,13 +67,12 @@ export default class MyNewHint implements IHint {
context.on('element', validateElement);
context.on('fetch::end::*', validateFetchEnd);
// As many events as you need, you can see the
// list of events [here](../connectors/
// As many events as you need
Hints are executed via [events](../connectors/ There are several
Hints are executed via [events][events]. There are several
events exposed by the connectors. The way to indicate which ones the hint cares
about is via the method `create`. This method returns an objects whose keys
are the names of the events and the values the event handlers:
@@ -147,6 +146,7 @@ The hint can access the custom configuration via `context.hintOptions`.
<!-- Link labels: -->
[custom hint]: ../guides/
[events]: ../getting-started/
[json schema]:
[new issue]:
[npx issue]:
@@ -153,7 +153,7 @@ engine.executeOn(url, {content: '{{your content}}'});
## Differences among connectors
Connectors are expected to implement at least some basic functionality
(see [how to develop a connector](../../contributor-guide/connectors/
(see [how to develop a connector][how to connector])
but expose more events or have some extra functionality. The following
document details the known differences or issues among the official
@@ -183,5 +183,6 @@ connectors.
[how to connector]: ../../contributor-guide/how-to/
@@ -66,11 +66,11 @@ Note: If you are running customs hints the buttons `Why is this important`
and `How to solve it` will not work.
If you want to implement your own `formatter`, visit the [contributor
guide][contributor guide]
guide][contributor guide].
<!-- Link labels: -->
[contributor guide]: ../../../contributor-guide/formatters/
[contributor guide]: ../../contributor-guide/how-to/
@@ -1,9 +1,9 @@
# Hints
A `hint` is a test that your website needs to pass. `webhint` comes with
a few [built in ones](../hints/), but you can create your own or download
a few [built in ones][hints], but you can create your own or download
them from `npm`. You can read more about [how to create hints in the
contributor guide](../../contributor-guide/hints/
contributor guide][how to hint].
## Hint configuration
@@ -81,4 +81,9 @@ or
You can check which hints accept this kind of configuration by
visiting the [hints documentation](../hints/).
visiting the [hints documentation][hints].
<!-- Link labels: -->
[hints]: ../hints/
[how to hint]: ../../contributor-guide/how-to/
@@ -36,4 +36,4 @@ browserslist.defaults = [
[browserslist defaults]:
[doc modes]: ../hints/hint-highest-available-document-mode/
[doc modes]:
@@ -16,4 +16,6 @@ There are a couple things to take into account:
when it is the only open tab so if you can only be authenticated
during the length of a session you might have some problems.
[chrome configuration]: ../../concepts/connectors/#rdc-config
<!-- Link labels: -->
[chrome configuration]: ../concepts/

This file was deleted.

Oops, something went wrong.
@@ -16,6 +16,6 @@ assumed in the guides.
<!-- Link labels: -->
[local server]: ./local-server/
[travis azure]: ./travis-and-azure/
[local server]: ./
[travis azure]: ./
[webhint github]:
@@ -32,7 +32,7 @@
## Other
* [`no-broken-links`](../../../../hint-no-broken-links)
* [`no-broken-links`](../../../../hint-no-broken-links/
## Performance
@@ -20,7 +20,7 @@ You can also install it as a `devDependency` if you prefer not to
have it globally (which is the team's preferred option).
**NOTE**: If you run into any issues during the install process
please check the [troubleshoot section](./troubleshoot/).
please check the [troubleshoot section](./troubleshoot/
`webhint` needs a configuration file to know what `hint`s,
`connector`s, etc. to use. By default it will look for a `.hintrc`
@@ -95,14 +95,13 @@ This configuration will be equivalent to the following `.hintrc`:
Now that you have `webhint` up and running, it is time to learn a bit more
about the different pieces:
* [Hints](./concepts/hints/)
* [Configurations](./concepts/configurations/)
* [Connectors](./concepts/connectors/)
* [Formatters](./concepts/formatters/)
* [Parsers](./concepts/parsers/)
* [Hints](./concepts/
* [Configurations](./concepts/
* [Connectors](./concepts/
* [Formatters](./concepts/
* [Parsers](./concepts/
<!-- Link labels: -->
[npm use package manager]:
[web recommended]:
@@ -11,5 +11,5 @@ get started:
<!-- Link labels: -->
[apache config]: ./apache/
[iis config]: ./iis/
[apache config]: ./
[iis config]: ./
@@ -67,6 +67,7 @@ globally.
[new issue]:
[npm change default directory]:
[npm use package manager]:
[optional canvas]:
[permission issue]:

0 comments on commit 7f0d899

Please sign in to comment.