Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow for spaces in site_name of sub-docs #56

Closed
jaklan opened this issue Sep 29, 2021 · 3 comments · Fixed by #58
Closed

Allow for spaces in site_name of sub-docs #56

jaklan opened this issue Sep 29, 2021 · 3 comments · Fixed by #58
Labels

Comments

@jaklan
Copy link

jaklan commented Sep 29, 2021

Hi, currently the plugin fails if any of sub-projects' site name include whitespaces. The assumption is to use that name just to generate an URL, because we show the root site name anyway, so whitespaces seem redundant. However:

  • when you move some repository to monorepo - you need to remember to edit the site_name, because it would fail otherwise
  • if you want to generate a mkdocs site just for given sub-project (e.g. you work on a sub-project workspace in VS Code) - you get an ugly site title with dashes / underscores / slashes

Imho it can be fixed easily - instead of forbidding whitespaces, let's just replace them with underscores automatically by plugin when reading the config values. This way we don't introduce any breaking changes and we make the transition to monorepo even easier 😉

❯ mkdocs serve
INFO     -  Building documentation...
[mkdocs-monorepo] Site name can only contain letters, numbers, underscores, hyphens and forward-slashes. The regular expression we test against is '^[a-zA-Z0-9_\-/]+$'.
@fmg-dave
Copy link

+1

I would also like this feature.

@camilaibs
Copy link
Contributor

Hello @jaklan and @fmg-dave do you still have the same problem after this pull request #58 was merged?

Please let us know if we can close this issue 🙌🏻

@camilaibs camilaibs added the enhancement New feature or request label Dec 15, 2021
@camilaibs camilaibs linked a pull request Dec 15, 2021 that will close this issue
@soapraj
Copy link
Contributor

soapraj commented Feb 10, 2022

Closing this issue. Please re-open if needed.

@soapraj soapraj closed this as completed Feb 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants