ember-cli-addon-docs

Easy, beautiful docs for your OSS Ember addons

Usage no npm install needed!

<script type="module">
  import emberCliAddonDocs from 'https://cdn.skypack.dev/ember-cli-addon-docs';
</script>

README

ember-cli-addon-docs

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

Compatibility

  • Ember.js v3.20 or above
  • Ember CLI v3.20 or above
  • Node.js v12 or above

2/28/20 Update: AddonDocs is in Maintenance Mode.

AddonDocs is still actively being used by many addons, but is effectively in maintenance mode as the original authors are no longer working on this project.

So, there's lots of good stuff in here, but use it at your own risk!

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.