Relative_path_html

New in v1.2.0

This setting will allow you to compile the website in a way that can be browsed directly from your filesystem (i.e. without running an http server).

This can be useful if you want a basic website for personal use, and don't want to remember to turn on the http server every time.

In some edgecases, you might want to use relative_path_html in conjunction with a webserver. For example if you add in custom integrations that require relative html paths.

In versions v1.2.1 and v1.2.0, this setting will enable NoTabs Mode and disable Graph view. This was turned off from version v1.2.2 onwards, as the relative_path_html setting may be used with a webserver, and in those cases the tabs and graph view will work.

If you intend to use the files directly from your filesystem, be sure to select a layout that is not tabs and disable the Graph view and search features. (JS file fetching is not allowed via the filesystem, so these functions have to be disabled for the site to work at all in this mode.)

To enable this mode, add the following to your config.yml:

toggles:
  relative_path_html: True

And here is the code to disable graph view and the search feature:

toggles:
  features:
    styling: 
      layout: documentation # set to documentation or minimal, not tabs
    graph:
      enabled: False 
    search:
      enabled: False

Testing showed that this setting will also work with a webserver, but at the moment this is not a main feature, so regression testing is absent and a general your-mileage-may-vary warning applies. If you find issues with this settings, be sure to visit Report Issues & Request features so that we can mature this mode.