Skip to content

v0.5.1

Compare
Choose a tag to compare
@samselikoff samselikoff released this 20 Aug 14:38
517c686

Enhancements and changes

  • Addon Docs comes with automatic support for versioned documentation, and in this release we've reorganized the site structure for those versions a bit. The biggest change is that the "latest" version of your docs (typically the most recently tagged release), which used to live under the URL /latest, now lives at the root of your site. (For example, www.ember-cli-mirage.com instead of www.ember-cli-mirage.com/latest). Other versions now live under a /versions namespace.

    This version should automatically migrate previous versions of your project to use the new structure. It also redirect old links from /latest to the new root location. If something isn't working right, please reach out to us in an issue here or in #ec-addon-docs in Slack.

  • Addon Docs uses utility CSS classes to style its components (DocsHero, DocsDemo, etc.). These classes are provided by TailwindCSS and have names like text-center. These classes should be considered private to Addon Docs, but due to CSS's global nature these generic names have been conflicting with addon authors' own CSS classes.

    In this release we've updated our Tailwind build to prefix all class names with ad-. There should be no upgrade steps for you unless you were relying on the included Tailwind build to style your dummy app. If so, you'll need to provide those classes yourself. The ad- classes should also not be relied upon and should still be considered private. This is so we can change them – and in fact we will be soon, as the ad- prefix is considered advertisement CSS and blocked by certain ad-blockers.

    Update: We have released 0.5.2, which changes the prefix to docs-, since ad- was causing so much trouble.

  • <DocsDemo> can accept additional CSS classes for customization.

Breaking changes

None.

Other

  • Fixed a bug where API reference pages weren't showing up in search.
  • Other bugfixes & upgrades.