lukasgeiter
commented
3 years ago That's an interesting idea. However, I think it is indeed outside of the scope of this plugin. The good news is that since awesome-pages simply modifies the existing MkDocs nav structure, building a new plugin on top of it shouldn't be too hard. In fact I already put together a little prototype which seems to work quite well:
from mkdocs.plugins import BasePlugin
from mkdocs.utils import normalize_url
class InlineNavigationPlugin(BasePlugin):
def on_nav(self, nav, config, files):
self.nav = nav
def on_post_page(self, output, page, config):
if '{nav}' in output:
children = page.parent.children if page.parent else self.nav.items
siblings = [child for child in children if child != page]
return output.replace('{nav}', self._format_links(siblings, page, config))
def _format_links(self, items, page, config):
result = '<ul>'
for item in items:
result += '<li>'
if item.is_section:
result += item.title
result += self._format_links(item.children, page, config)
else:
url = normalize_url(item.url, page)
result += f'<a href="{url}">{item.title}</a>'
result += '</li>'
result += '</ul>'
return resultI won't be publishing this as a package - I've already got enough on my hands. But feel free to use the code, modify it or even publish it as a plugin yourself. Refer to the MkDocs documentation on developing plugins.
Andre601
oprypin
Not sure if this would be either out of scope, or even impossible to implement, but how about having a way to generate a TOC inside a page, by using a specific placeholder for it?
Example
The following structure is present:
I now set up a
.pages.ymlfile inassetsto ignore the folder and one inpostswith the following structure:Finally, do I add the following to my
index.md:The
{nav}placeholder would now take all pages it can find in thepostsdirectory and also go through any additional directories found there. It will however skip the file it is used in.Once it has all pages, will it generate a list that could look like this:
It would take the names to display from either the nav-section in the
.pagesfile, or from the pages themself.Why?
This plugin is useful for when you want to have the nav updated without needing to always set it yourself, but won't obviously work for when you have a manual nav inside a specific file.
For me is that the case with a blog I have. While I no longer need to update the nav myself do I always have to update the list in the index.md of my posts directory, which is frustrating sometimes.
Having a way to automate this using a placeholder or similar would really help a lot.
I hope this is somewhat doable.