Skip to content

Commit

Permalink
Improve protocols documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
tmpfs committed Aug 7, 2016
1 parent 2e9f6f2 commit f10bb96
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 9 deletions.
4 changes: 1 addition & 3 deletions documents/include/protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,9 @@ const options = {
You can now use HTTP and HTTPS imports:

```html
<link rel="import" href="https://domain.com/components.html">
<link rel="import" href="https://example.com/components.html">
```

Plugin functions are invoked synchronously before the [load][] plugin executes; they allow HTML imports to be mapped to different protocols.

### Writing Protocol Plugins

Protocol plugins follow the standard plugin function signature `function(state, conf)` however unlike other plugins they are invoked synchronously and passed a reference to the protocol registry.
Expand Down
4 changes: 1 addition & 3 deletions manual/protocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,9 @@ const options = {
You can now use HTTP and HTTPS imports:

```html
<link rel="import" href="https://domain.com/components.html">
<link rel="import" href="https://example.com/components.html">
```

Plugin functions are invoked synchronously before the [load][] plugin executes; they allow HTML imports to be mapped to different protocols.

### Writing Protocol Plugins

Protocol plugins follow the standard plugin function signature `function(state, conf)` however unlike other plugins they are invoked synchronously and passed a reference to the protocol registry.
Expand Down
5 changes: 2 additions & 3 deletions packages/plugin-load/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,11 +105,9 @@ const options = {
You can now use HTTP and HTTPS imports:

```html
<link rel="import" href="https://domain.com/components.html">
<link rel="import" href="https://example.com/components.html">
```

Plugin functions are invoked synchronously before the [load][] plugin executes; they allow HTML imports to be mapped to different protocols.

### Writing Protocol Plugins

Protocol plugins follow the standard plugin function signature `function(state, conf)` however unlike other plugins they are invoked synchronously and passed a reference to the protocol registry.
Expand Down Expand Up @@ -228,6 +226,7 @@ Created by [mkdoc](https://github.com/mkdoc/mkdoc) on August 7, 2016
[resolver-http]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-http
[resolver-npm]: https://github.com/tmpfs/trucks/blob/master/packages/resolver-npm
[generator-page]: https://github.com/tmpfs/trucks/blob/master/packages/generator-page
[standalone-manual]: https://github.com/tmpfs/trucks/blob/master/manual/standalone.md
[less-css]: http://lesscss.org/
[sass-css]: http://sass-lang.com/
[stylus-css]: http://stylus-lang.com/
Expand Down

0 comments on commit f10bb96

Please sign in to comment.