A documentation framework for Ember addons that generates beautiful, easy-to-maintain docs directly from your code.
Ember CLI Addon Docs is a documentation framework for Ember.js addons that generates beautiful, interactive documentation sites directly from your addon's source code. It solves the problem of maintaining accurate and up-to-date documentation by automating API reference generation and allowing live component demos. The framework integrates seamlessly into the Ember CLI workflow, making documentation a natural part of the addon development process.
Ember.js addon authors and maintainers who need to create and maintain professional documentation for their open-source or internal addons.
Developers choose Ember CLI Addon Docs because it provides a complete, Ember-native solution for documentation that reduces maintenance overhead through automation and offers interactive demos that enhance the user experience for other developers using their addons.
Easy, beautiful docs for your OSS Ember addons
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
Generates API references directly from JavaScript and TypeScript code, eliminating manual updates and ensuring accuracy as the addon evolves.
Embeds editable Ember components into docs, allowing users to tweak code in real-time, which enhances learning and testing directly in the browser.
Hosts documentation for multiple addon versions, critical for maintaining backward compatibility and supporting users across different releases.
Seamlessly integrates into the Ember CLI workflow, making documentation a natural part of the development process with minimal setup overhead.
Exclusively designed for Ember.js addons, making it unsuitable for projects outside the Ember ecosystem and limiting adoption for multi-framework teams.
With original maintainers moved on, ongoing development relies on community contributions, which can lead to slower feature updates and potential stability risks, as noted in the README.
Still working on embroider and fastboot support, meaning current users may face limitations or need workarounds for advanced Ember features and performance optimizations.