-
Notifications
You must be signed in to change notification settings - Fork 1
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 related content support and navigation using keywords #8
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
auareyou
approved these changes
Jan 16, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
danielguillan
approved these changes
Jan 17, 2024
Merged
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.
Adds feature to enable related content through Markdown front matter.
🔗 Try it here
How it works
Related content links appear on all content pages, except the homepage. They are located beneath the main content.
The links are generated through a combination of
keywords
andrelated
links for maximum flexibility and catchment of content, all of is are managed via the Markdown files frontmatter.Non-specific keywords
The easiest way to link pages is through sharing related keywords. E.g.
accessibility
,branding
etc.The technical approach works by reading the optional
keyword
property in front matter, and finding matches in adjacent pages. If matches are found, aRelated content
navigation menu will appear beneath the main content.Specific links
For scenario's wher fine-grained control is required for cross-linking, such as external links or custom labels, a
related
key is also available which accepts a more verboseObject
type.🔗 See this Markdown example
Screenshot