Releases: ember-learn/ember-cli-addon-docs
v0.5.3
Bugfixes.
v0.5.2
Changes
- We changed our Tailwind build to use a
docs-prefix instead ofad-, sincead-was getting picked up and ignored by ad blockers.
Breaking changes
- None.
v0.5.1
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.cominstead ofwww.ember-cli-mirage.com/latest). Other versions now live under a/versionsnamespace.This version should automatically migrate previous versions of your project to use the new structure. It also redirect old links from
/latestto the new root location. If something isn't working right, please reach out to us in an issue here or in#ec-addon-docsin 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. Thead-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 thead-prefix is considered advertisement CSS and blocked by certain ad-blockers.Update: We have released 0.5.2, which changes the prefix to
docs-, sincead-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.
v0.5.0
Breaking changes
- Live examples (
docs-demo.live-example) have been removed due to complexity and filesize. We are investigating alternatives, including the ability to embed Twiddles.
Other
- Bugfixes
v0.4.3
v0.4.1
Adds a version selector to the top navbar.
Other changes:
- Main navigation is now independently scrollable
- Bugfixes
v0.4.0
- We dropped official support for Node 4
- Bugfixes
v0.3.0
- [ BREAKING ] If you have any config for
ember-router-scrollin your dummy app'sconfig/environment, you can remove it. (The<body>element is the only scrollable element now.) - [ BREAKING ] Renames
{{docs-navbar}}to{{docs-header}} - [ BREAKING ]The setup for your dummy app's
/docs/template.hbsis simpler and should be updated. Check out the docs for example usage. - The navigation section of
{{docs-viewer}}has a new contextual component{{viewer.section}}that you should use to group your guides. (The nav layout was designed to expect a section for the first item). See the docs for example usage. - [ BREAKING ] Removes yield for alt-logo in docs-hero. The block below the byline is now yielded. (We will introduce a new api for custom project logos later).
- Adds
stylearg to docs-hero which can be "light" or "dark". Defaults to "light".
v0.2.4
v0.1.4
Breaking change: You now must always pass the file extension into the DocsSnippet component: {{docs-snippet name='foo.js'}}
Addon docs now works in Fastboot
And more bug fixes.