Skip to content


Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP


Index Links are incorrect in companion documentation #324

Cocoanetics opened this Issue · 3 comments

2 participants


Both links at the top of a companion page generated from a markdown template are incorrect, the lead to docs/index.html which does not exist. They should instead lead to the index.html at the html root.


The problem occurs if you use the --include folder option to import an entire folder contents of template files. If you include the individual template files and images then this does not occur.


This was definitely working correctly, so was likely broken with updates. Will check, and if quick fix will do it, otherwise it'll have to wait a bit.

@sammyd sammyd referenced this issue from a commit in sammyd/appledoc
@sammyd sammyd Ensures links to doc root in --include docs point to correct place
The template had a fixed relative link to the doc index as ../index.html
which breaks for included docs. A fixed link cannot be used because
the directory structure of included documentation is preserved.

We add a new string to the page dictionary which generates the correct
relative link (in the same way the CSS links are created). This is used
instead of the fixed link.

Fixes: #324

Closing this as it seems to be fixed with #350. Feel free to reopen or comment in case of further development.

@tomaz tomaz closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.