Question 1

How to change the default colors in Ember Freestyle?

Accepted Answer

Use Sass variables like $FreestyleGuide-color--primary in your stylesheet after importing 'ember-freestyle'. This allows custom theming while leveraging the base styles. If you disable default styles, you'll need to write CSS from scratch.

Question 2

Does Ember Freestyle work with Ember Octane?

Accepted Answer

Yes, it's compatible with Ember.js v3.24 and above, which includes Octane editions. The addon supports modern Ember features and has TypeScript types for Glint usage.

Question 3

Ember Freestyle vs Storybook for Ember: which is better?

Accepted Answer

Ember Freestyle is lighter and integrates seamlessly into your Ember app, ideal for quick internal guides. Storybook offers more features like addons and multi-framework support but requires separate setup and may not capture Ember-specific context as well.

Question 4

How to embed a freestyle guide in a specific component route?

Accepted Answer

Place the `{{freestyle-guide}}` component in any template or route. You can delete the generated freestyle route and manually add the guide elsewhere, as noted in the README's flexibility section.

Question 5

Can I use Ember Freestyle to document an Ember addon?

Accepted Answer

Yes, but it must be listed in devDependencies, and for V2 addons, you need to configure babel with the Freestyle AST transform to capture source code from usage examples, as detailed in the README.

Question 6

Is Ember Freestyle still maintained and updated?

Accepted Answer

The project shows active maintenance with CI badges, recent contributor activity, and compatibility with Ember versions up to v4.x. However, major updates may depend on community contributions given its niche focus.

ember-freestyle

What is ember-freestyle?

Overview

Use Cases

Best For

Related Projects

Found a gem we're missing?

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions