A suite of components for building readme-style docs into your stories.


3.6.64 years ago5 years agoMinified + gzip package size for @atlaskit/util-readme in KB


Atlaskit component registry Commitizen friendly semantic-release Report an issue


The Readme component is used to generate elegant and featureful Readme's for any React Component.

Try it out

Detailed docs and example usage can be found here.


npm install @atlaskit/util-readme

* Please note that this module could have dependencies that are governed by the Atlassian Design Guidelines license which will be automatically included on install. Each dependency has a license file that indicates whether the Atlassian Design Guidelines license applies.

We're here to help!

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

Are you in trouble? Read through our contribution guidelines and raise an issue to us.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.