Use a relative path for docs index page logo #1276
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Changes the paths for the logo on the index page of the documentation to use relative links instead of absolute ones. The current absolute path is just fine as long as the site is not hosted under another directory. When opening files locally (without serving them in docfx) these images will fail to load. In addition, if these files are served under a directory that is not the root endpoint (like: `docs.com/stable/`) the images will also break. I tested these changes locally using these steps: - Build & serve docs: `docfx docs/docfx.json --serve` - Verify that logo shows up on index page using all 3 themes - Open `docs/_site/index.html` - Verify logo works on all 3 themes
|
@foxbot this will likely affect you, since you were planning on updating your documentation, and your site hosts the latest docs under |
foxbot
approved these changes
Mar 16, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes the paths for the logo on the index page of the documentation
to use relative links instead of absolute ones.
Before:
After:
The current absolute path is just fine as long as the site is not hosted under another directory. When opening files locally (without serving them in docfx) these images will fail to load.
In addition, if these files are served under a directory that is not the root endpoint (like:
docs.com/stable/) the images will also break.I tested these changes locally using these steps:
docfx docs/docfx.json --servedocs/_site/index.htmlAlso includes a minor grammar fix.