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

Site site_url for mkdocs #1854

Merged
merged 1 commit into from
Jun 22, 2021
Merged

Site site_url for mkdocs #1854

merged 1 commit into from
Jun 22, 2021

Conversation

misilot
Copy link
Contributor

@misilot misilot commented Jun 22, 2021

Since mkdocs v1.2 site_url is now required.

  • Update mkdocs.yml

Purpose / why

Bring back the clean URL's that are indexed in Google

What changes were made?

Added site_url to mkdocs.yml

Verification

Build mkdocs and see that directories are created for each page, instead of .html pages

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

Interested Parties

@Islandora/documentation


Checklist

Pull-request reviewer should ensure the following

Person merging should ensure the following

  • Does mkdocs still build successfully? (This is indicated by TravisCI passing. To test locally, and see warnings, see How To Build Documentation.)
  • If pages are renamed or removed, have all internal links to those pages been fixed?
  • If pages are added, have they been linked to or placed in the menu?
  • Did the PR receive at least one approval from a committer, and all issues raised have been addressed?

Since mkdocs v1.2 site_url is now required.

* Update mkdocs.yml
Copy link
Member

@rosiel rosiel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested, and it works both in mkdocs 1.1.2 and 1.2.

@rosiel rosiel merged commit 76c93f5 into Islandora:main Jun 22, 2021
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