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

Use symlinks in docs/ to configure redirects? #13

Open
osresearch opened this issue Apr 18, 2020 · 2 comments
Open

Use symlinks in docs/ to configure redirects? #13

osresearch opened this issue Apr 18, 2020 · 2 comments

Comments

@osresearch
Copy link

An alternate way to configure the redirections would be to use symlinks in the docs/ directory. That way it would not require editing the mkdocs.yaml file for every redirect and might be an easier way to manage the files.

@ghost
Copy link

ghost commented Jul 14, 2020

Personally, I'm not sure about this. I have many redirects configured at the moment (300+) and I prefer to have them explicitly configured on a centralized location. It also makes it easier to see the changes to the redirects in the git history.

@ktomk
Copy link

ktomk commented Oct 1, 2020

I'm using symbolic links to create the docs/ (docs_dir) content as the repository file-layout is not inherently compatible with the docs/ (docs_dir) base in Mkdocs. This works very well with Mkdocs and turning all those into redirects would not work.

So to answer your question raised with this issue: No, do not use symlinks in docs/ to configure redirects as they first of all work for the actual content which is incompatible with redirects.

To generalize: Such a change would break compatibility with Mkdocs. Symbolic links have a different meaning for Mkdocs already, it is not possible to use them as redirects as well.

Please let me know if you think this is an over-generalization.

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