Issue with swup and javascript

[garazdawi]

In order to create links from the sidebar to other application I generate markdown files that look like this:

# compiler

<script>window.location.replace("../lib/compiler/doc/html/index.html");</script>

This no longer works as swup does not execute the javascript. I tried using the new exdoc:loaded:

# compiler

<script>window.addEventListener("exdoc:loaded", () => { window.location.replace("../lib/compiler/doc/html/index.html"); });</script>

and while that works, the event is triggered rather late so that you can see the rendered page flicker by before the redirect happens.

Any suggestions on what I should do?

[josevalim]

@garazdawi we do support a new redirects option, would that work well:

ex_doc/lib/mix/tasks/docs.ex

Line 162 in c2c994a

* `:redirects` - A map or list of tuples, where the key is the path to redirect from and the

?

[garazdawi]

I had forgotten about those. I will try it.

[garazdawi]

Yes, that works! Great!

It seems a bit fragile though as essentially what happens is that original the .html files for the markdown is generated and those are then overwritten by the redirect files.

[josevalim]

@garazdawi alternatively we could support this:

extras: [
  "foo": [redirect: "bar"]
]

Basically, if we have a redirect key, then we also generate the redirect page but keeping the sidebar link. Would that help?

[garazdawi]

Would it not then just be better to have:

extras: [
  "foo": [url: "bar"]
]

and have the link directly on the sidebar? Which is what I'm trying to achieve anyway.

[josevalim]

Yes, agreed. If you want to submit a PR, feel free, otherwise open up an issue and it will eventually be tackled. :) Just need to remember we should probably discard those for epub. :)

[garazdawi]

Opened an issue. I will use my workaround for now, I'll try to get some time to work on a PR.