Link the keywords to their respective pages #244
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
|
Looks great already @AgniveshChaubey ! One small thing: because in the future we might want to link to keywords from older dialects, etc:
|
jviotti
reviewed
Jun 3, 2024
| @@ -41,9 +41,9 @@ related: | |||
| keyword: unevaluatedProperties | |||
| --- | |||
|
|
|||
| The `additionalProperties` keyword is used to control the handling of properties whose names are not listed in the `properties` keyword or match any of the regular expressions in the `patternProperties` keyword. By default any additional properties are allowed. | |||
| The {{<keyword-link name="additionalProperties" >}} keyword is used to control the handling of properties whose names are not listed in the {{<keyword-link name="properties" >}} keyword or match any of the regular expressions in the {{<keyword-link name="patternProperties" >}} keyword. By default any additional properties are allowed. | |||
There was a problem hiding this comment.
Can we always require a vocabulary name when using the shortcode? As we might be linking to keywords in other vocabularies?
jviotti
reviewed
Jun 3, 2024
| {{- end -}} | ||
| {{- $url := index $keywordMap $keyword -}} | ||
| {{- if $url -}} | ||
| <a href="{{ $url }}">{{ $keyword }}</a> |
There was a problem hiding this comment.
Hugo has a ref shortcode that ensures the destination is a valid page (thus protecting against broken links): https://gohugo.io/content-management/cross-references/. Can you make use of those here?
|
I am a bit busy these days, so I haven't had much time to work on this. Let the PR remain open; I'll finish it up whenever I get some free time. |
|
Yeah, no hurries! |
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.
Addresses #188.
This is an initial PR. Here, I have added a shortcode to link the keywords to their corresponding pages. Please take a look and confirm whether I should proceed with this or not.