@atlaskit/util-dmd-plugin

ak-dmd-plugin

A dmd plugin for AtlasKit documentation.

Modifications

• Add the @js and @html tags, which can be used inside an @example tag to mark it as a JavaScript or HTML example:

/**
 * @example @js console.log('Hello world!');
 */

• Add the @playground tag, which can be added to an @example tag to mark it as code used in interactive examples on the AtlasKit registry.

/**
 * @example @html @playground <p>Hello world!</p>
 */

• Modify the index of members to list properties, methods, and events separately.

See dmd and jsdoc-to-markdown for more information.

stripTags(str, tags)

Strip '@'-prefixed tags from a string

Kind: global function

Param	Type	Description
str	string	The string
tags	Array.<string>	The tags to strip.

Example

stripTags('@example My example', ['example']);

Support and feedback

We're here to help!

Let us know what you think of our components and docs, your feedback is really important for us.

Community support

Ask a question in our forum.

Check if someone has already asked the same question before.

Create a support ticket

Are you in trouble? Let us know!