new optimizer readme #346
Merged
new optimizer readme #346
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ithinkihaveacat
approved these changes
Jun 6, 2019
|
|
||
| Currently the following options are supported: | ||
| ```shell | ||
| $ npx @ampproject/toolbox-cli myFile.html |
There was a problem hiding this comment.
There's no command required?
There was a problem hiding this comment.
I don't think so, but I'll try once it's deployed
packages/optimizer/README.md
Outdated
|
|
||
| // retrieve the latest runtime version | ||
| const runtimeVersion = require('amp-toolbox-runtime-version'); | ||
| const ampOptimiser = require('@ampproject/toolbox-optimizer'); |
There was a problem hiding this comment.
Maybe this should be ampOptimizer, for consistency with the package name. (As an Australian used to British spelling, I am very reluctant to mention this…)
|
|
||
| [](https://badge.fury.io/js/amp-toolbox-optimizer) | ||
|
|
||
| AMP Optimizer - the performance optimizations of the AMP Cache on your own site. | ||
| AMP Optimizer is a tool to server-side enhance the rendering performance of AMP pages. AMP Optimizer implements [AMP performance best practices](https://amp.dev/documentation/guides-and-tutorials/optimize-and-measure/optimize_amp?format=websites) and supports [AMP server-side-rendering](https://amp.dev/documentation/guides-and-tutorials/optimize-and-measure/server-side-rendering?format=websites). By default, it will perform the following optimizations: |
There was a problem hiding this comment.
I think it's worth mentioning that the optimizer generates valid AMP (given valid input) somewhere here for clarity (even if briefly) especially since this is a change from previous versions.
There was a problem hiding this comment.
good point! Done!
packages/optimizer/README.md
Outdated
| * The AMP boilerplate gets removed. Instead the `v0.css` is added. | ||
| * AMP layout classes are added to the `amp-img` extension. | ||
| * `<link rel="amphtml" href="canonical.amp.html">` gets added linking to the valid AMP version. | ||
| This transformer supports the following option: |
packages/optimizer/README.md
Outdated
| AMP Runtime being loaded, which improves load times. | ||
| Example: | ||
| ``` | ||
| const ampOptimiser = require('@ampproject/toolbox-optimizer'); |
There was a problem hiding this comment.
Maybe change this to "optimizer" too…
| to: | ||
| ``` | ||
| // globally | ||
| const optimizer = AmpOptimzer.create({ |
There was a problem hiding this comment.
s/AmpOptimzer/AmpOptimizer/
sebastianbenz
commented
Jun 7, 2019
packages/optimizer/README.md
Outdated
|
|
||
| // retrieve the latest runtime version | ||
| const runtimeVersion = require('amp-toolbox-runtime-version'); | ||
| const ampOptimiser = require('@ampproject/toolbox-optimizer'); |
packages/optimizer/README.md
Outdated
| * The AMP boilerplate gets removed. Instead the `v0.css` is added. | ||
| * AMP layout classes are added to the `amp-img` extension. | ||
| * `<link rel="amphtml" href="canonical.amp.html">` gets added linking to the valid AMP version. | ||
| This transformer supports the following option: |
packages/optimizer/README.md
Outdated
| AMP Runtime being loaded, which improves load times. | ||
| Example: | ||
| ``` | ||
| const ampOptimiser = require('@ampproject/toolbox-optimizer'); |
|
|
||
| Currently the following options are supported: | ||
| ```shell | ||
| $ npx @ampproject/toolbox-cli myFile.html |
There was a problem hiding this comment.
I don't think so, but I'll try once it's deployed
|
|
||
| [](https://badge.fury.io/js/amp-toolbox-optimizer) | ||
|
|
||
| AMP Optimizer - the performance optimizations of the AMP Cache on your own site. | ||
| AMP Optimizer is a tool to server-side enhance the rendering performance of AMP pages. AMP Optimizer implements [AMP performance best practices](https://amp.dev/documentation/guides-and-tutorials/optimize-and-measure/optimize_amp?format=websites) and supports [AMP server-side-rendering](https://amp.dev/documentation/guides-and-tutorials/optimize-and-measure/server-side-rendering?format=websites). By default, it will perform the following optimizations: |
There was a problem hiding this comment.
good point! Done!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.