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

Please allow overriding use_directory_urls option via a command line flag #1401

Closed
mitya57 opened this issue Feb 3, 2018 · 4 comments
Closed

Comments

@mitya57
Copy link
Contributor

mitya57 commented Feb 3, 2018

Dear mkdocs developers,

Some projects have use_directory_urls: true in their mkdocs.yml files, which creates some problems when browsing the documentation locally.

I am Debian packager, and we often package documentation to make it easier for developers to browse it locally. So it would be nice to have a --use-directory-urls=false flag (or similar) to override that setting, so that I don’t have to patch mkdocs.yml.

@waylan
Copy link
Member

waylan commented Feb 3, 2018

That seems like a reasonable reason for adding that option. However, it's not going to be high on my priority list, so a PR is more likely to get the change made sooner than later.

@laoshaw
Copy link
Contributor

laoshaw commented Dec 25, 2018

use-directory-urls: false does not work in mkdocs.yml while using 1.0.4, also 'mkdocs build --use-directory-urls=false' reports 'no such option', when can we have 'use-directory-urls=false'? my markdown files are generated locally and I would like to browse them without a http server sometimes.

@waylan
Copy link
Member

waylan commented Dec 25, 2018

use-directory-urls: false does not work in mkdocs.yml while using 1.0.4

Please report this as a separate issue.

@mitya57
Copy link
Contributor Author

mitya57 commented Dec 25, 2018

@laoshaw In mkdocs.yml it should be use_directory_urls, with underscores and not with hyphens.

jimporter added a commit to jimporter/mkdocs that referenced this issue Dec 16, 2019
…esolves mkdocs#1401

In addition, this patch standardizes the list of build arguments that can be
passed to commands that build docs (build, serve, and gh-deploy). All three
can now use --config-file, --strict, --theme, --theme-dir, and the new
--use-directory-urls/--no-directory-urls.
jimporter added a commit to jimporter/mkdocs that referenced this issue Dec 16, 2019
…esolves mkdocs#1401

In addition, this patch standardizes the list of build arguments that can be
passed to commands that build docs (build, serve, and gh-deploy). All three
can now use --config-file, --strict, --theme, --theme-dir, and the new
--use-directory-urls/--no-directory-urls.
@waylan waylan closed this as completed in f70a48e Dec 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants