Hosting in Virtual Directory (GitHub Pages)

[JoshClose]

I'll be deploying this by just outputting the build to the /docs folder of my repository. That means it will be hosted from owner.githubpages.io/repository. I'm trying to figure out the combination of settings to build it to work like that. I also would like to be able to run in a virtual directory during preview if possible.

I set

LinkRoot: /repository

All this seems to do is spit out errors when I run saying "Could not validate relative link" because my links don't start with /repository.

I see issue statiqdev/Statiq.Web#735 but don't see a setting to enable that in Statiq Web.

It seems to work if I use the link shortcode. Is there a way to turn it on globally or globally or for markdown pages?

[daveaglick]

Bummer, looks like the MarkdownPrependLinkRoot setting didn't come over from the old blog recipe. I'll open an issue to add that back in the next version (statiqdev/Statiq.Web#947).

In the meantime, you can modify the Markdown template to enable prepending the link root since the actual RenderMarkdown module has support for it (there just isn't a setting in Statiq Web to turn it on):

bootstrapper
// ...
  .ModifyTemplate(MediaTypes.Markdown, module => ((RenderMarkdown)module).PrependLinkRoot(true))

As for previewing, you can have the preview server put the site at a virtual directory with --virtual-dir <PATH> on your command line. That combined with the LinkRoot setting will let you serve the site locally as if it were in the subfolder on GH Pages.

Let me know if this does the trick!

[JoshClose]

I'm also running into this issue in the markdown files now. statiqdev/Statiq.Web#744 I don't see how the workaround will work with markdown.

[JoshClose]

I created a feature request for some link stuff which I'm willing to take a try at. statiqdev/Statiq.Framework#170

[daveaglick]

Is Context.GetLink the way I should do that?

Yep, the GetLink() methods are the right way. ~/ is generally a server-side convention (I.e. it works when the server sees that as a request for a resource and can figure out the path on it's file system based on the root of the site). I've considered trying to rewrite those kind of links so the output HTML contains the correct link including LinkRoot setting but haven't ever gotten far enough along to look closer.

[daveaglick]

Is it normal to have every markdown link have a warning

It's definitely not intended. In fact, the link validation analyzer was designed to support the LinkRoot setting. I wonder if the way .PrependLinkRoot(true) is changing the links is somehow interfering with the analyzer (I tested with relative links and LinkRoot, there's even unit tests, but not PrependLinkRoot()). Let me dig a little deeper on this one and get back to you.

[daveaglick]

I'm also running into this issue in the markdown files now...I don't see how the workaround will work with markdown

Yeah, good call since GetLink() is being called by the module and not directly. I'm not even sure the idea of adding an overload that takes a fragment would work in that case. The GetLink() will need to accept a fragment as part of the link and treat it as such without any extra hinting. I'll follow up with some more thoughts in statiqdev/Statiq.Framework#170.