search

oprypin / mkdocs-literate-nav

MkDocs plugin to specify the navigation in Markdown instead of YAML
https://oprypin.github.io/mkdocs-literate-nav
MIT License
73 stars 8 forks source link

Only SUMMARY.md works #2

Closed majkinetor closed 3 years ago

majkinetor commented 3 years ago

I tried it and README.md and other stuff do not work.

I tried to not specify nav_file as doc mention defaults or specify README.md.

BTW, you should document mention that section-index should come after this plugin in settings or it doesn't work

oprypin commented 3 years ago

The base claim appears to be not true to me.

If you take any working site with "SUMMARY.md" and change only that too "foo.md", also making sure to rename the file accordingly, it will still work. I just tried that.

Also README.md I'm using here and it works as well https://github.com/oprypin/crsfml/tree/master/docs/tutorials

If you wish to back up your claim, please produce a self-contained mkdocs site source (repository) that sees this behavior.

BTW, you should document mention that section-index should come after this plugin in settings or it doesn't work

Right... I'll get to that

oprypin commented 3 years ago

The latter is addressed as https://github.com/oprypin/mkdocs-literate-nav/commit/fd23bda00402692ece9690c8b2ae70fe5471ae34 + https://github.com/oprypin/mkdocs-section-index/commit/145ce693fa86d950e602fc8f6eab1ea29c8be236 (neither included in a release yet)

majkinetor commented 3 years ago

If you wish to back up your claim, please produce a self-contained mkdocs site source (repository) that sees this behavior.

OK, I will see too do that. Just wanted to confirm here first.