docs: improve rendering of links for local markdown files #1177
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
Hugo is not really good when it comes to linking markdown files, if they are not within an own folder. With this improvement, we will fetch all relative links, even with `.md` and generate their url different than the [originial version](https://gohugo.io/templates/render-hooks/#link-with-title-markdown-example). Signed-off-by: Simon Schrottner <[email protected]>
aepfli
requested review from
thisthat,
thschue,
bacherfl and
StackScribe
as code owners
github-actions
bot
added
the
documentation
✅ Deploy Preview for keptn-lifecycle-toolkit ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
This is the first step to fixing issues in #1162 |
|
incorporate this change also in #1045 - after merge - this can be part of the theme and should not be here |
|
Kudos, SonarCloud Quality Gate passed!
|
StackScribe
approved these changes
Apr 4, 2023
mowies
approved these changes
Apr 4, 2023
mowies
changed the title
Merged
aepfli
added a commit
to keptn/docs-tooling
that referenced
this pull request
Apr 4, 2023
Hugo could be better when linking markdown files if they are outside their own folder. With this improvement, we will fetch all relative links, even with `.md,` and generate their url different than the [originial version](https://gohugo.io/templates/render-hooks/#link-with-title-markdown-example). This change now also allows links to `.md` files within the links, so we don't need to care about this anymore. In Hugo you can write documentation with two different naming/structuring approaches: 1. `<docName>/_index.md` 2. `<docName>.md` The problem is that links from files within the second approach could be simpler. Locally and in the Markdown space, they're in the same folder. But when Hugo renders them, there is a folder level in between. With this approach, we're changing how hugo renders relative files. Rather than blindly using the link for pages within the documentation, we search for that page, and take the link from this page, generate via Hugo. This way we will always have the right directory levels, for markdown and for hugo relates: keptn/lifecycle-toolkit#1177 Signed-off-by: Simon Schrottner <[email protected]>
aepfli
added a commit
to keptn/docs-tooling
that referenced
this pull request
Apr 4, 2023
Hugo could be better when linking markdown files if they are outside their own folder. With this improvement, we will fetch all relative links, even with `.md,` and generate their url different than the [originial version](https://gohugo.io/templates/render-hooks/#link-with-title-markdown-example). This change now also allows links to `.md` files within the links, so we don't need to care about this anymore. In Hugo you can write documentation with two different naming/structuring approaches: 1. `<docName>/_index.md` 2. `<docName>.md` The problem is that links from files within the second approach could be simpler. Locally and in the Markdown space, they're in the same folder. But when Hugo renders them, there is a folder level in between. With this approach, we're changing how hugo renders relative files. Rather than blindly using the link for pages within the documentation, we search for that page, and take the link from this page, generate via Hugo. This way we will always have the right directory levels, for markdown and for hugo relates: keptn/lifecycle-toolkit#1177 Signed-off-by: Simon Schrottner <[email protected]>
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.
Hugo could be better when linking markdown files if they are outside their own folder. With this improvement, we will fetch all relative links, even with
.md,and generate their url different than the originial version.This change now also allows links to
.mdfiles within the links, so we don't need to care about this anymore.Background
In Hugo you can write documentation with two different naming/structuring approaches:
<docName>/_index.md<docName>.mdThe problem is that links from files within the second approach could be simpler. Locally and in the Markdown space, they're in the same folder. But when Hugo renders them, there is a folder level in between.
With this approach, we're changing how hugo renders relative files. Rather than blindly using the link for pages within the documentation, we search for that page, and take the link from this page, generate via Hugo. This way we will always have the right directory levels, for markdown and for hugo
relates: #1170