diff options
| author | Peter Bacon Darwin | 2014-02-07 20:40:35 +0000 | 
|---|---|---|
| committer | Peter Bacon Darwin | 2014-02-16 19:03:41 +0000 | 
| commit | 2f7c57233ad2d578952dbba5c63ae8d50c1b487a (patch) | |
| tree | c14f91ad8429dd4c0b93bbc89dbd37ac4382f1e2 /src/ng/sce.js | |
| parent | 1192ae44f1d7f944719520f235e9f2ec895bdfd5 (diff) | |
| download | angular.js-2f7c57233ad2d578952dbba5c63ae8d50c1b487a.tar.bz2 | |
docs(bike-shed-migration): let markdown deal with extenal links
It is problematic to use {@link} tags with external links because the
markdown parser converts them to links for us before we parse the @links.
This means that the following tag:
```
{@link http://www.google.com Google}
```
get converted to:
```
{@link <a href="http://www.google.com/"></a> Google}
```
Our {@link} parser then converts this to:
```
<a href="<a"><</a>href="http://www.google.com/"></a> Google}
```
which is clearly a mess.  The best solution is not to use {@link} tags
for external links and just use the standard markdown syntax:
```
[Google](http://www.google.com)
```
In the long run, we could look into configuring or modifying `marked` not
to convert these external links or we could provide a "pre-parser"
processor that dealt with such links before `marked` gets its hands on it.
Diffstat (limited to 'src/ng/sce.js')
| -rw-r--r-- | src/ng/sce.js | 4 | 
1 files changed, 2 insertions, 2 deletions
| diff --git a/src/ng/sce.js b/src/ng/sce.js index 6bcd05cc..1c93160d 100644 --- a/src/ng/sce.js +++ b/src/ng/sce.js @@ -485,8 +485,8 @@ function $SceDelegateProvider() {   *   * *Please note*:   * The browser's - * {@link https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest - * Same Origin Policy} and {@link http://www.w3.org/TR/cors/ Cross-Origin Resource Sharing (CORS)} + * [Same Origin Policy](https://code.google.com/p/browsersec/wiki/Part2#Same-origin_policy_for_XMLHttpRequest) + * and [Cross-Origin Resource Sharing (CORS)](http://www.w3.org/TR/cors/)   * policy apply in addition to this and may further restrict whether the template is successfully   * loaded.  This means that without the right CORS policy, loading templates from a different domain   * won't work on all browsers.  Also, loading templates from `file://` URL does not work on some | 
