Skip to content

Commit e3cb492

Browse files
committed
Update docs
1 parent 0aac9b3 commit e3cb492

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Activate the plugin in **mkdocs.yml**, along with actually changing `docs_dir`
1919
(normally, MkDocs *absolutely wouldn't* let you set it to `.`):
2020

2121
```yaml
22-
site_name: mkdocs-same-dir
22+
site_name: foo
2323
docs_dir: .
2424
site_dir: ../site
2525

@@ -31,3 +31,9 @@ plugins:
3131
and now you can move this **mkdocs.yml** into your **docs** directory, or move your docs alongside **mkdocs.yml**.
3232
3333
[**See example layout**](https://github.com/oprypin/mkdocs-same-dir/tree/master/example)
34+
35+
### Important notes
36+
37+
Another necessary effect of this plugin is that files *directly at the root* of the **docs** dir will no longer be picked up, unless they are Markdown files.
38+
39+
And note that the [implementation](https://github.com/oprypin/mkdocs-same-dir/blob/master/mkdocs_same_dir/plugin.py) of this plugin is a huge hack that monkeypatches MkDocs' internals. But I pledge to keep up with MkDocs updates and keep it working as long as that's still possible.

example/mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
site_name: mkdocs-same-dir
1+
site_name: foo
22
docs_dir: .
33
site_dir: ../site
44

0 commit comments

Comments
 (0)