fix(theme-docs): remove redundant header #722
Merged
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.
Types of changes
Description
It is explained in documentation that
category
in front-matter is optional. However, theme docs renders the category header in AppNav component regardless of existence of it.category
is completely not defined in front-matter, theme docs rendersundefined
as a uppercase text.category
is set as an empty string in front-matter, theme docs renders an empty p element with margin-bottom.Reproduction Link (CodeSandbox)
With my PR,
category
in front-matter is validated incontent:file:beforeInsert
hook, and is set as an empty string if it's falsy or not a string. Coercion to an empty string is for its type to match that described in documentation.In addition, if
category
is an empty string (i.e. falsy), now AppNav component doesn't render the category header (the p element).Checklist:
I tested my changes in local by
yarn link
the modified package.