Support docs from the root directory.#3450
Conversation
|
It might be worth considering an "ignore" option for |
fb5cd7d to
42ff3a1
Compare
This comment was marked as abuse.
This comment was marked as abuse.
|
To be clear, it's still usable as is. A normal user would not even notice the extra site folder since nothing links to it. It just copies more than it needs to into the temp directory that serves the site. It performs as expected on a normal build. |
0389e27 to
68ad2a3
Compare
68ad2a3 to
d153d4a
Compare
|
Note that advertising that |
|
I wouldn't advocate for changing the default from the 'docs' directory. I think there are legitimate use cases for wanting to call mkdocs from root though. It's a feature that's been requested a fair amount through mkdocs history. |
This comment was marked as abuse.
This comment was marked as abuse.
This comment was marked as abuse.
This comment was marked as abuse.
|
This feature would be useful for documentation-only sites and personal sites deployed with pages. This can be done with https://github.com/jupyter-book/jupyter-book, which might be a good resource. Here's an example... Note, another related feature (if not already implemented) would be to allow the |
Per discussion #3062 this change would allow users to build a mkdocs site from the root directory.
This change removes the validation checks for the site directory to not be within the docs directory.
If the site folder is within the docs directory, it will mark them as 'EXCLUDED'
Tested: