@salesforcedevs/sfdocs-remark-lint-tabset
v0.0.1
Published
Validate the custom tab plugin syntax, properties and throw error/warning respectively
Downloads
447
Maintainers
Keywords
Readme
remark-lint-tabset
This Markdown plugin is designed to validate the correct usage of the tabset
and tab
directive in Markdown files.
Why/What
We have build custom plugin to auther the tab as part of LWC2.0. This plugin ensures proper usage of the tabs feature in markdown by performing the following validations:
Correct Syntax Delimiters: Verifies that tabset uses
::::::
and each tab uses:::::
as required.Matching Tab Count: Ensures the number of
tab
sections matches the number of tab labels defined in thetabs
property within thetabset
.Empty Tab Content: Checks that each tab section contains content, issuing a warning for any tabs left blank to prevent unintentional empty tabs.
Unique Tab Labels: Confirms that all tab labels in the
tabs
property are unique.No Tabset After H2: Ensures that a
tabset
is not placed after an H2 heading to prevent disrupting the content flow on the page.Correct Tabset Properties: Validates that all properties specified for the
tabset
are correct.
Install & build
yarn install && yarn build
Pubilsh
yarn publish
Please make sure to push your changes (version number & other changes) to git once publishing is complete.