eddyluten / mkdocs-categories-plugin Goto Github PK

Hi @EddyLuten,

Thanks for writing this plugin! I ran some tests with it and all seemed fine while hosting the MkDocs site files from the root of the website, e.g. site_url: https://www.example.com in mkdocs.yml. However, I found that the plugin does not work properly when hosting the files in a subdirectory of the site. E.g. site_url: https://www.example.com/subdir.

The problem lies in the fact that the plugin generates absolute links. Meaning: the category links on the category index page are always prefixed with /categories; it does not take the subdir in account. The same is true for the category pages (which contain links to the pages on which the category is used on) and the 'normal' pages, on which the categories of that page are listed.

The MkDocs documentation states that absolute paths with links are not officially supported (source) and that relative paths are to be used.

I prepared a small patch which makes the plugin generate relative links. Could you please take a look at it and share your thoughts? Thanks!

-Remy

plugin.py.patch.txt

Is it possilbe to define a hierarchy of categories so that each category page shows both pages directly assigned to it, as well as child categories? This is standard in mediawiki.

For example, given the following hierarchy, there will be a Boeing category page that shows both any pages directly assigned to the Boeing category, and it will show two child categories: 737 Max and 737-300.

Vehicles
--Airplanes
----Boeing
------737 Max
------737-300
----Airbus
------A320neo
------A380
--Cars
----Tesla
------Model 3
------Model Y
----Ford
------Explorer
------Focus