Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Absolute symlinks within generated docs #13

Open
craigmcc opened this issue Apr 4, 2023 · 1 comment
Open

Absolute symlinks within generated docs #13

craigmcc opened this issue Apr 4, 2023 · 1 comment

Comments

@craigmcc
Copy link

craigmcc commented Apr 4, 2023

I really like the looks of the output from typedoc-theme-yaf. However, because it uses typedoc-plugin-versions under the covers, the symbolic links that get created are absolute ones -- relative to the directory hierarchy on my development environment.

That makes it basically impossible to transport the generated docs directory to some static webserver, or publish it as GitHub Pages.

Is there any way that you (or the maintainers if any for typedoc-plugin-versions) could make relative symbolic links possible?

@citkane
Copy link
Owner

citkane commented Apr 6, 2023

Hi @craigmcc

Typedoc-plugin-versions was written as a precursor to this theme, but made published as a separate module for reasons of practicality.

I remember there being issues at the time of writing with symlinks and GitHub. I will need to wrap my head around these again as it was a while ago!

Would you raise this issue on that project page so that my co-maintainer can have eyes in it too.

For use of this theme on GitHub (which does work with the symlinks as they are, depending on how you approach the problem 😅), see the CID guide in the Readme for using GitHub workflows: https://github.com/citkane/typedoc-plugin-versions#cid

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants