Ember Cli Addon Docs

Overview

The project, ember-cli-addon-docs, offers easy documentation for Ember addons. It is compatible with Ember.js v4.4 or above, Ember CLI v4.4 or above, and Node.js v18 or above. The original maintainers have moved on, but the project is actively maintained and welcomes contributions to enhance support for embroider and fastboot.

Features

• GitHub Actions Integration: Utilizes continuous integration and deployment.
• Compatibility: Supports Ember.js, Ember CLI, and Node.js versions specified.
• Active Maintenance: Continuously maintained and used by many addons.
• Support for Embroider and Fastboot: Ongoing development to add support for embroider and fastboot.
• Community Involvement: Requests feature input through issues with emoji reactions.
• Documentation View: Easy access to and viewing of addon documentation.

Installation

To install the theme, follow these steps:

1. First, clone the repository: git clone [repository-url]
2. Navigate into the project directory: cd project-directory
3. Install dependencies: npm install
4. Run the development server: ember serve
5. Access the documentation at: http://localhost:4200

Summary

The ember-cli-addon-docs project offers a straightforward solution for creating documentation for Ember addons. With continuous maintenance and compatibility with the latest versions of Ember.js, Ember CLI, and Node.js, this project remains a valuable resource for many addon developers. The invitation for community input and contributions ensures the project’s growth and adaptability.