mkdocs-material icon indicating copy to clipboard operation
mkdocs-material copied to clipboard

Add description for extra.scope option

Open Bizordec opened this issue 1 year ago • 3 comments

Description

This option useful in case when you build subsites separately. For example, for this structure

.
└── /
    ├── A/
    ├── B/
    └── C/

each site will have its own state for palette (/A/.palette, /B/.palette, /C/.palette). To share the same state between all subsites, you could set scope: /.

It was already described here (https://github.com/squidfunk/mkdocs-material/issues/1914#issuecomment-882025594), but is still missing in the docs.

Related links

Proposed change

No response

Before submitting

Bizordec avatar Sep 04 '23 07:09 Bizordec

Thanks for reporting! Would you like to submit a PR? ☺️ Do you have a proposal where this should be located?

squidfunk avatar Sep 04 '23 12:09 squidfunk

Yep, I've submitted! I think it should have its own page in Setup section.

Bizordec avatar Sep 04 '23 21:09 Bizordec

We've decided to close the PR, as we're not planning to add an entire section on this, but as already explained in https://github.com/squidfunk/mkdocs-material/pull/5967#issuecomment-1706033417, we'll shortly add a multi-site guide that will include and explain this setting ☺️

squidfunk avatar Sep 18 '23 18:09 squidfunk

I've finally found some time to add this to the documentation – I used large parts of your PR #5967, so I tagged you as a co-author ☺️ The current place might not be perfect, but we'll shortly revise our documentation, so we'll likely move it around.

Fixed in f494840bd.

squidfunk avatar May 15 '24 15:05 squidfunk