馃摉 Fix amp-script doc #29582
馃摉 Fix amp-script doc #29582
Conversation
sebastianbenz
commented
Jul 30, 2020
sebastianbenz
commented
- normalize headings
- fix broken raw tag
- mention toolbox csp lib instead of suggesting implementing on your own
- remove experimental flag
* normalize headings * fix broken raw tag * mention toolbox csp lib instead of suggesting implementing on your own * remove experimental flag
| @@ -32,7 +31,7 @@ An `amp-script` element can load JavaScript in two ways: | |||
| - remotely, from a URL | |||
| - locally, from a `<script>` element on the page | |||
|
|
|||
| #### Load JavaScript from a remote URL | |||
| ### Load JavaScript from a remote URL | |||
There was a problem hiding this comment.
Thanks for fixing these! This was also on my to-do list. Now I don't have to :)
|
|
||
| ```js | ||
| function generateCSPHash(script) { |
There was a problem hiding this comment.
Good idea to suggest that people do this by importing the toolbox. Especially as then they'll be up-to-date if somehow we ever change the way this is calculated. I did also change the docs to mention the toolbox earlier.
That said, I think people should also know how to do this themselves - and providing the sample code is more explicit than the instructions I gave.
Why don't we include both methods?
There was a problem hiding this comment.
Developers should use the toolbox library instead of implementing it on their own. This gives us an easier upgrade path if we'd decide to change the implementation in the future. If they want to see the implementation they can look at the source code of the NPM module.
extensions/amp-script/amp-script.md
Outdated
| @@ -205,6 +206,8 @@ function generateCSPHash(script) { | |||
| } | |||
| ``` | |||
|
|
|||
| There also a node module available which does it for you: [@ampproject/toolbox-script-csp](https://www.npmjs.com/package/@ampproject/toolbox-script-csp). | |||
There was a problem hiding this comment.
Can you change "There also" to "There is also"?
* 馃摉 Fix amp-script doc * normalize headings * fix broken raw tag * mention toolbox csp lib instead of suggesting implementing on your own * remove experimental flag * fix more indentation * re-add node snippet * fix wording
