Permalink
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/
[newformatter]:../how-to/formatter/
[new parser]: ../how-to/parser/
[new hint]: ../how-to/hint/
[default configuration]: ../../user-guide/index.md#default-configuration
[events]: ./events.md
[new connector]: ../how-to/connector.md
[new formatter]: ../how-to/formatter.md
[new parser]: ../how-to/parser.md
[new hint]: ../how-to/hint.md
[npm]: https://www.npmjs.com/
[typescript]: https://www.typescriptlang.org/
@@ -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/index.md#interact-with-other-services).
other services](../how-to/common-hint-scenarios.md#interact-with-other-services).
## `traverse::down`
@@ -205,7 +205,7 @@ hintRunner.testHint(hintPath, tests, {
<!-- Link labels: -->
[browserconfiguration]: ../../../user-guide/configuring-webhint/browser-context/
[browserconfiguration]: ../../user-guide/configuring-webhint/browser-context.md
[new issue]: https://github.com/webhintio/hint/issues/new
[parsers]: ../../../user-guide/concepts/parsers/
[parsers]: ../../user-guide/concepts/parsers.md
[ssllabs code]: https://github.com/webhintio/hint/blob/master/packages/hint-ssllabs/src/hint.ts
@@ -132,8 +132,8 @@ following tests:
[depth-first search]: https://en.wikipedia.org/wiki/Depth-first_search
[iconnector interface]: https://github.com/webhintio/hint/blob/master/packages/hint/src/lib/types/connector.ts
[jsdom]: https://github.com/tmpvar/jsdom
[events]: ../getting-started/events/
[jsdom]: https://github.com/jsdom/jsdom
[events]: ../getting-started/events.md
[events scanstart]: ../getting-started/events.md#scanstart
[events fetchstart]: ../getting-started/events.md#fetchstart
[events fetcherror]: ../getting-started/events.md#fetcherror
@@ -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/events.md).
// As many events as you need
}
}
```
Hints are executed via [events](../connectors/events.md). 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/create-custom-hint.md
[events]: ../getting-started/events.md
[json schema]: http://json-schema.org/
[new issue]: https://github.com/webhintio/hint/issues/new
[npx issue]: https://github.com/npm/npm/issues/17869
@@ -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/index.md))
(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
connectors.
@@ -183,5 +183,6 @@ connectors.
[cdp]: https://chromedevtools.github.io/devtools-protocol/
[eda]: https://github.com/Microsoft/edge-diagnostics-adapter
[how to connector]: ../../contributor-guide/how-to/connector.md
[jsdom]: https://github.com/tmpvar/jsdom
[wsl-interop]: https://msdn.microsoft.com/en-us/commandline/wsl/release_notes#build-14951
@@ -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/formatter.md
[formatter-json]: https://npmjs.com/package/@hint/formatter-json
[formatter-stylish]: https://npmjs.com/package/@hint/formatter-stylish
[formatter-codeframe]: https://npmjs.com/package/@hint/formatter-codeframe
@@ -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/index.md).
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/index.md
[how to hint]: ../../contributor-guide/how-to/hint.md
@@ -36,4 +36,4 @@ browserslist.defaults = [
[browserslist]: https://github.com/ai/browserslist#readme
[browserslist defaults]: https://github.com/ai/browserslist#queries
[doc modes]: ../hints/hint-highest-available-document-mode/
[doc modes]: https://webhint.io/docs/hints/hint-highest-available-document-mode/
@@ -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/connectors.md#rdc-config

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]: ./local-server.md
[travis azure]: ./travis-and-azure.md
[webhint github]: https://github.com/webhintio/hint/issues/new
@@ -32,7 +32,7 @@
## Other
* [`no-broken-links`](../../../../hint-no-broken-links)
* [`no-broken-links`](../../../../hint-no-broken-links/README.md)
## 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/summary.md).
`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/hints.md)
* [Configurations](./concepts/configurations.md)
* [Connectors](./concepts/connectors.md)
* [Formatters](./concepts/formatters.md)
* [Parsers](./concepts/parsers.md)
<!-- Link labels: -->
[nodejs]: https://nodejs.org/en/download/current/
[npm use package manager]: https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-3-use-a-package-manager-that-takes-care-of-this-for-you
[web recommended]: https://github.com/webhintio/hint/blob/master/packages/configuration-web-recommended/index.json
@@ -11,5 +11,5 @@ get started:
<!-- Link labels: -->
[apache config]: ./apache/
[iis config]: ./iis/
[apache config]: ./apache.md
[iis config]: ./iis.md
@@ -67,6 +67,7 @@ globally.
[homebrew]: https://brew.sh/
[new issue]: https://github.com/webhintio/hint/issues/new
[npm change default directory]: https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-2-change-npms-default-directory-to-another-directory
[npm use package manager]: https://docs.npmjs.com/getting-started/fixing-npm-permissions#option-3-use-a-package-manager-that-takes-care-of-this-for-you
[nvm]: https://github.com/creationix/nvm
[optional canvas]: https://github.com/webhintio/hint/commit/47d51aeaa187351267f7b4cabd3f075de49d043d
[permission issue]: https://github.com/webhintio/hint/issues/308

0 comments on commit 7f0d899

Please sign in to comment.