Document the <base> relative link strategy

fvsch commented 8 years ago

Current doc: https://github.com/fvsch/kirby-staticbuilder/blob/master/doc/options.md#html-pages-outside-of-a-web-site

I’m not really happy with how poorly it explains how to prepare for a fully static site that may not be served with HTTP or hosted at the root of a domain.

Anyway, document the other option, which is:

// config.localhost.php
c::set([
    'plugin.staticbuilder.enabled'  => true,
    'plugin.staticbuilder.baseurl'  => '',
    'plugin.staticbuilder.uglyurls' => true
]);

// snippets/header.php
<head>
<?php
  $base = './';
  $max = $page->isHomePage() ? 0 : $page->depth();
  for($i=1; $i < $max; $i++) { $base .= '../'; }
  echo "<base url=\"$base\">";
?>

fvsch commented 7 years ago

I'm tempted to remove the relative URLs feature, only keeping the <base url="..."> strategy.

This means:

providing a helper function to output the base tag or nothing (depending if we're running a build or not)
removing a bunch of code and complexity (https://github.com/fvsch/kirby-staticbuilder/blob/master/src/Builder.php#L202-L269)
major release (breaking feature)

fvsch commented 7 years ago

Nope, I’ll keep the relative URLs feature and make it the default in 3.0. It seems to work well in simple settings, and if it's broken for some things it should be fixed.

fvsch / kirby-staticbuilder

Document the <base> relative link strategy #17