Rendering and deploying previews using GitHub about franklin.jl HOT 4 CLOSED

Hello @Saransh-cpp help with the docs is very welcome.

what you're suggesting is very close to what is currently being done for the julialang website (see the gh-previews branch: https://github.com/JuliaLang/www.julialang.org/tree/gh-preview/previews). Each of these subfolder contains a functional copy of the site with the changes from that preview and with paths properly set (e.g. href="/previews/PR1682/.... if you look at https://github.com/JuliaLang/www.julialang.org/blob/gh-preview/previews/PR1682/index.html).

I think it would be pretty straightforward to adapt that so that it dumps these preview subfolders onto gh-pages itself in a dedicated folder with a special name (just previews works but there might be a risk of clash). Let's assume for now you keep everything the same and use previews, you'd then do (pretty much as you suggest)

www.fluxml.ai/previews/PR165/

you could even have a robot posting that preview link (as is done on the julialang site except that it's done for Netlify)

hope this helps and ping me here (or from the fluxml repo) if you encounter an issue or would like to review something (and please if all this ends up working for you, an addition to the docs would be amazing, thanks!)

from franklin.jl.

wonderful, thanks in advance for the added section and glad that you made this work @Saransh-cpp (and don't hesitate to link to your repo + site in the docs)

from franklin.jl.

(I can update the docs if this will work, or if someone here has tried this out!)

from franklin.jl.

Thank you for the suggestions, @tlienart! I got this to work!! I will add a new deployment section to Franklin's website this week (and also update some outdated deployment documentation)!

Crossposting this from FluxML/fluxml.github.io -

Here is the working demo -

• The test repository - https://github.com/Saransh-cpp/fluxml-franklin-port/tree/main
• The deployed website - https://saransh-cpp.github.io/fluxml-franklin-port/
• A PR that tries to remove some contents from the website - Saransh-cpp/fluxml-franklin-port#1
• The bot's comment - Saransh-cpp/fluxml-franklin-port#1 (comment)
• The preview documentation - https://saransh-cpp.github.io/fluxml-franklin-port/previews/PR1

from franklin.jl.