Repository navigation
Add "Profile" to Terms and defintions - #1095
Merged
Merged
Conversation
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
zvr
requested changes
Aug 28, 2024
Co-authored-by: Alexios Zavras (zvr) <zvr+git@zvr.gr> Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
zvr
approved these changes
Aug 28, 2024
This file contains hidden or 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
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.
Will resolve #1088
Please suggest style/format of the definition list.
--
Currently, it put terms as a H2 heading, with definition as following paragraphs.
As a result, terms will also showing in the side navigation bar.
--
Alternatively, it is also possible in MkDocs to use a Markdown syntax to generate standard HTML tags for a definition list (<dl> for list, <dt> for term, and <dd> for description), which in general will work better with a screen reader:
This code:
will generate
--
Which one we prefer?
With the compatibility with our current PDF generation in mind.