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

Add site_url #2130

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add site_url #2130

wants to merge 1 commit into from

Conversation

Shrinks99
Copy link
Member

Changes

  • Tells MkDocs where the site will be published at allowing it to generate a sitemap

### Changes

- Tells MkDocs where the site will be published at allowing it to generate a sitemap
@Shrinks99 Shrinks99 requested a review from SuaYoo November 5, 2024 23:25
@ikreymer
Copy link
Member

ikreymer commented Nov 5, 2024

This should probably be parametrized, since local deployment will have the docs hosted locally at: http://localhost:30870/docs/ or a local domain...

@Shrinks99
Copy link
Member Author

Shrinks99 commented Nov 6, 2024

I don't think it does much that would affect the local builds? The value is ignored for the locally built sitemap with mkdocs serve

Details here: https://www.mkdocs.org/user-guide/configuration/#site_url

...That said you're also not wrong! What would be the best way of making this variable? Could add a line that appends it to the docs deploy script?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants