@salesforcedevs/sfdocs-remark-specification-plugin
v0.0.1
Published
SFDocs remark plugin for specification page
Downloads
361
Readme
Component Specification plugin
About
This is a custom plugin for authoring the speciifcation tab content in a markdown file. This plugin transforms the authored specification syntax into html components.
Example: ::component-specification{component="button" model="lwc" namespace="lightning"}
Transformed html using this specification plugin is as follows:
<doc-specification-content component="button" model="lwc" namespace="lightning" router-url=${cx_router_url}>
</doc-specification-content>
Install & build
yarn install && yarn build
Pubilsh
To test the plugin code, publish alpha package using following command:
yarn publish --new-version 1.0.0-alpha --tag alpha --access=public
Use following command to publish actual package:
yarn publish
Please make sure to push your changes (version number & other changes) to git once publishing is complete.
Testing
For testing purpose, set the environment variable:
CX_ROUTER_API_BASE_URL: 'https://cx-mock-router-internal-07a18d7b3f61.herokuapp.com'