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

Missing hint in documentation #3

Open
koffeiniker opened this issue Jun 12, 2021 · 1 comment
Open

Missing hint in documentation #3

koffeiniker opened this issue Jun 12, 2021 · 1 comment

Comments

@koffeiniker
Copy link

I honestly believe that a hint, that the pandoc module needs use_directory_urls on false to work properly would be great.

Without this setting, images are expected in a subdirectory for the page by mkdocs but in the docs directly for pandoc. So either maintain symlinks or two copies of images or ... set this config to false. I think the README should reflect this.

@alexandre-perrin
Copy link
Owner

Hi @koffeiniker

I'm not sure if I understand. This option is meant to create URLs to pages as directories names instead of pages:
e.g. https://mypage.org.io/subpage instead of https://mypage.org.io/subpage.html

See https://www.mkdocs.org/user-guide/configuration/#use_directory_urls

It is not meant to modify relative path. I haven't seen any difference in generating with or without this option enabled.
Could you provide more information?

  • version of mkdocs
  • structure of your project
  • steps to reproduce

Thanks

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