Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ember-cli-addon-docs

ember-learn26.7kMIT8.0.8

Easy, beautiful docs for your OSS Ember addons

ember-addon, ember-cli-deploy-plugin

readme

ember-cli-addon-docs

npm version This project uses GitHub Actions for continuous integration and continuous deployment.

Compatibility

  • Ember.js v4.4 or above
  • Ember CLI v4.4 or above
  • Node.js v18 or above

The original maintainers of AddonDocs have moved on, but this addon is still very much actively maintained and is still being used by many addons. We are currently working on embroider and fastboot support, and would love help, if anyone would like to help out!

If you run into parts of the guides that are confusing or out-of-date, check the issues/PRs, or hop into the #ec-addon-docs channel in Discord.

Easy documentation for Ember addons.

View the docs here.

Feature requests

Please open an issue and add a :+1: emoji reaction. We will use the number of reactions as votes to indicate community interest, which will in turn help us prioritize feature development.

You can view the most-upvoted feature requests with this link.

Getting help

Please open an issue or join the Ember community on Discord

About

Created and maintained by Dan Freeman, Chris Garrett, and Sam Selikoff. Thanks to all of our contributors!

License

This project is licensed under the MIT License.