ember-cli-addon-docs

Compatibility

• Ember.js v4.4 or above
• Ember CLI v4.4 or above
• Node.js v18 or above

The original maintainers of AddonDocs have moved on, but this addon is still very much actively maintained and is still being used by many addons. We are currently working on embroider and fastboot support, and would love help, if anyone would like to help out!

If you run into parts of the guides that are confusing or out-of-date, check the issues/PRs, or hop into the #ec-addon-docs channel in Discord.

Easy documentation for Ember addons.

View the docs here.

Feature requests

Please open an issue and add a :+1: emoji reaction. We will use the number of reactions as votes to indicate community interest, which will in turn help us prioritize feature development.

You can view the most-upvoted feature requests with this link.

Getting help

Please open an issue or join the Ember community on Discord

About

Created and maintained by Dan Freeman, Chris Garrett, and Sam Selikoff. Thanks to all of our contributors!

License

This project is licensed under the MIT License.

v8.0.8 (2024-12-06)

v8.0.7 (2024-12-06)

v8.0.6 (2024-12-06)

v8.0.5 (2024-12-06)

v8.0.4 (2024-12-06)

v8.0.3 (2024-12-06)

v8.0.2 (2024-12-05)

v8.0.0 (2024-12-05)

:boom: Breaking Change

• #1617 Switch default primary branch to main, update docs from Travis to GitHub Actions (@RobbieTheWagner)

Committers: 1

• Robbie Wagner (@RobbieTheWagner)

v7.2.2 (2024-11-20)

v7.2.1 (2024-11-20)

:bug: Bug Fix

• #1615 Recursively replace ADDON_DOCS_ROOT_URL (@RobbieTheWagner)

Committers: 1

• Robbie Wagner (@RobbieTheWagner)

v7.2.0 (2024-11-19)

:rocket: Enhancement

• #1582 Fix @ember/string dependency (@anehx)

:bug: Bug Fix

• #1556 Fixed typo in DocsViewer::XNav (@ijlee2)

:house: Internal

• #1595 Update babel, deps, ember, switch to pnpm (@RobbieTheWagner)

Committers: 3

• Isaac Lee (@ijlee2)
• Jonas Metzener (@anehx)
• Robbie Wagner (@RobbieTheWagner)

v7.0.1 (2024-02-06)

v7.0.0 (2023-12-24)

:boom: Breaking Change

• #1520 ember-cli update to 5.5.0, require node 18+ (@RobbieTheWagner)

:bug: Bug Fix

• #1517 fix compatibility with ember-data 5 (@AmauryD)

:house: Internal

• #1526 Update release-it (@RobbieTheWagner)
• #1518 Update prettier and fix lint (@RobbieTheWagner)

Committers: 2

• Amaury (@AmauryD)
• Robbie Wagner (@RobbieTheWagner)

v6.0.2 (2023-09-12)

:bug: Bug Fix

• #1485 Add ember-tether to dependencies (@barryofguilder)
• #1488 Forward @class argument in docs-viewer/x-nav-list component (@SergeAstapov)

Committers: 2

• Jason Barry (@barryofguilder)
• Sergey Astapov (@SergeAstapov)

v6.0.1 (2023-09-05)

:boom: Breaking Change

• #1478 Require ember >= 4.4, node >= 16 (@RobbieTheWagner)

:rocket: Enhancement

• #1454 embroider ready (@patricklx)

:bug: Bug Fix

• #1477 Add inverse: null to hasMany relationships (@Shishouille)
• #1460 pin ember-svg-jar to fix Embroider build (@patricklx)

Committers: 4

• Jordan Hawker (@elwayman02)
• Patrick Pircher (@patricklx)
• Robbie Wagner (@RobbieTheWagner)
• Shirin (@Shishouille)

v5.2.0 (2023-04-25)

:rocket: Enhancement

• #1421 Swap out 3rd party font for system fonts (@mixonic)

Committers: 3

• Jordan Hawker (@elwayman02)
• Matthew Beale (@mixonic)
• Sergey Astapov (@SergeAstapov)

v5.1.0 (2022-12-01)

:boom: Breaking Change

• #1363 Ember 4.8, require Ember 3.28+ (@rwwagner90)

:bug: Bug Fix

• #1276 avoid using this.set (Closes #1275) (@geneukum)

Committers: 2

• Geordan Neukum (@geneukum)
• Robert Wagner (@rwwagner90)

v5.0.0 (2022-06-30)

:boom: Breaking Change

• #1219 Drop Node.js 12 support (@SergeAstapov)
• #1134 update docs viewer (@miguelcobain)
• #1133 update markdown rendering approach (@miguelcobain)
• #1128 update docs header (@miguelcobain)
• #1130 update docs-link (@miguelcobain)
• #1126 delete docs-svg-icon component (@miguelcobain)
• #1120 Update to glimmer components (@miguelcobain)

:rocket: Enhancement

• #1218 Remove extra whitespace in <DocsLink /> component (@SergeAstapov)
• #1164 Support v2 addon format (@SergeAstapov)
• #1125 update docs-logo component (@miguelcobain)
• #1124 update docs-keyboard-shortcuts (@miguelcobain)

:bug: Bug Fix

• #1137 fix(config): use runtime config instead of embroider generated one (@jkeen)

:memo: Documentation

• #1123 update docs hero docs (@miguelcobain)

:house: Internal

• #1143 chore(config): remove all usage of ember-get-config (@anehx)
• #1135 Remove ember-decorators and ember-component-css (@rwwagner90)
• #955 Ember and dep updates (@rwwagner90)
• #1129 update modal dialog (@miguelcobain)
• #1127 update api components (@miguelcobain)
• #1117 update controllers syntax (@miguelcobain)
• #1118 update services (@miguelcobain)
• #1116 update ember-data related syntax (@miguelcobain)

Committers: 5

• Jeff Keen (@jkeen)
• Jonas Metzener (@anehx)
• Miguel Andrade (@miguelcobain)
• Robert Wagner (@rwwagner90)
• Sergey Astapov (@SergeAstapov)

v4.2.2 (2022-02-08)

:bug: Bug Fix

• #1108 Fix no implicit this deprecation in docs-demo component (@nickschot)
• #1045 Fix typo in <DocsKeyboardShortcuts /> component (@SergeAstapov)

:memo: Documentation

• #1083 Consolidate some docs (@rwwagner90)

:house: Internal

• #1084 ember-get-config 1.0.0, force embroider < 0.50 (@rwwagner90)
• #1019 Set default CI config blueprints to run all builds (@SergeAstapov)

Committers: 3

• Nick Schot (@nickschot)
• Robert Wagner (@rwwagner90)
• Sergey Astapov (@SergeAstapov)

v4.2.1 (2021-12-02)

v4.2.0 (2021-12-02)

:rocket: Enhancement

• #1016 Closes #195 use angle bracket component names (@miguelcobain)

:house: Internal

• #1031 Add babel.config.js to .npmignore (@SergeAstapov)

Committers: 2

• Miguel Andrade (@miguelcobain)
• Sergey Astapov (@SergeAstapov)

v4.1.0 (2021-12-01)

:bug: Bug Fix

• #1021 Fix LinkTo usage and explicitly provide @route and @models arguments (@SergeAstapov)
• #978 Fixes broken deployment with ember-auto-import@2 (@scalvert)

:memo: Documentation

• #1017 Fix typo in addon status callout (@SergeAstapov)
• #981 Fix typo at navigation (@brkn)

:house: Internal

• #1010 Update linting, bump deps (@rwwagner90)
• #1015 chore: import LinkComponent from ember/legacy-built-in-components (@gilest)
• #1006 chore(deps): drop ember-href-to (@gilest)

Committers: 5

• Berkan Ünal (@brkn)
• Giles Thompson (@gilest)
• Robert Wagner (@rwwagner90)
• Sergey Astapov (@SergeAstapov)
• Steve Calvert (@scalvert)

v4.0.3 (2021-10-07)

v4.0.2 (2021-09-20)

:bug: Bug Fix

• #940 fix: yarn.lock with ember-modal-dialog commit (@ndekeister-us)

Committers: 1

• Nathanaël Dekeister (@ndekeister-us)

v4.0.1 (2021-09-17)

:bug: Bug Fix

• #939 fix: move @glimmer/component and @glimmer/tracking in dependencies (@ndekeister-us)

Committers: 1

• Nathanaël Dekeister (@ndekeister-us)

v4.0.0 (2021-09-15)

:boom: Breaking Change

• #933 Require ember-auto-import 2 (@rwwagner90)

:rocket: Enhancement

• #932 Ember 4 support (@rwwagner90)
• #923 Bump some deps, update Ember to 3.28 (@rwwagner90)
• #890 Remove liquid fire (@rwwagner90)

:bug: Bug Fix

• #921 Resolve issue with sidebar showing incorrectly on mobile (@jkeen)

:house: Internal

• #934 Use colocated components (@rwwagner90)
• #891 Fix highlightjs deprecation (@rwwagner90)
• #887 Bump some deps, fix some lint (@rwwagner90)

Committers: 4

• Jeff Keen (@jkeen)
• Nathanaël Dekeister (@ndekeister-us)
• Robert Wagner (@rwwagner90)
• @dependabot-preview[bot]

v3.0.0 (2021-05-31)

:boom: Breaking Change

• #854 Drop ember-concurrency 1.x support, fix ember-keyboard deprecations (@rwwagner90)

:house: Internal

• #855 Ember 3.26 (@rwwagner90)

Committers: 2

• Robert Wagner (@rwwagner90)
• @dependabot-preview[bot]

v2.0.0 (2021-05-25)

:boom: Breaking Change

• #842 ember-modal-dialog 4.0.0-alpha.0, Drop support for <=Ember 3.19, Node 10 (@elwayman02)
• #693 Remove pods support (@rwwagner90)
• #692 Remove ESDoc support (@rwwagner90)

:rocket: Enhancement

• #767 Update to ember-router-scroll v4 (@Windvis)
• #747 Remove brand bg color (@rwwagner90)

:house: Internal

• #831 Fixed deprecations this.property-fallback, with, and positional linkt… (@bgantzler)
• #727 Update html-entities (@rwwagner90)

Committers: 5

• Jordan Hawker (@elwayman02)
• Robert Wagner (@rwwagner90)
• Sam Van Campenhout (@Windvis)
• @bgantzler
• @dependabot-preview[bot]

v1.0.0 (2020-12-10)

:boom: Breaking Change

• #668 Use postcss for sass, convert to angle brackets, update highlight.js (@rwwagner90)
• #553 Minimum 3.x series for ember-data addon (@snewcomer)

:house: Internal

• #671 Start converting to native classes (@rwwagner90)
• #585 Add test for both ember-concurrency v1 and v2 (@maxfierke)

Committers: 5

• Isaac Lee (@ijlee2)
• Max Fierke (@maxfierke)
• Robert Wagner (@rwwagner90)
• Scott Newcomer (@snewcomer)
• @dependabot-preview[bot]

v0.10.0 (2020-09-08)

:rocket: Enhancement

• #552 Add ember-data as a peer dep (@snewcomer)
• #516 ember-href-to 4.0.0 (@rwwagner90)

Committers: 3

• Robert Wagner (@rwwagner90)
• Scott Newcomer (@snewcomer)
• @dependabot-preview[bot]

v0.9.0 (2020-08-10)

:boom: Breaking Change

• #495 Ember 3.20, update ember-fetch, bump deps (@rwwagner90)

:rocket: Enhancement

• #496 Update ember-cli-clipboard (@rwwagner90)

Committers: 2

• Robert Wagner (@rwwagner90)
• @dependabot-preview[bot]

v0.8.0 (2020-08-01)

:boom: Breaking Change

• #475 ember-cli 3.18, some lint fixes (@rwwagner90)
• #474 Remove ember-component-css, drop Ember 2.18 support (@rwwagner90)

Committers: 1

• Robert Wagner (@rwwagner90)

v0.7.0 (2020-05-05)

:boom: Breaking Change

• #466 Ember 3.17 updates, drop node 8 support (@rwwagner90)

:rocket: Enhancement

• #472 Adds tailwind list style classes (@rwwagner90)
• #469 [feature] be able to render tables from markdown (@gabrielcsapo)
• #444 Use Tailwind's scrolling-touch instead of custom overflow-momentum (@josemarluedke)

:bug: Bug Fix

• #451 fix deprecation computed-property.override by adding setters (@kturney)
• #450 fix deprecation ember-data:default-serializer (@kturney)
• #452 fix array helper clobbering built in helper (@kturney)
• #443 Fix docs heading styles due to Tailwind's v1 preflight (@josemarluedke)

:memo: Documentation

• #461 Use section instead of item for Introduction (@elwayman02)
• #449 tip: Visual Studio Code addon-docs integration (@lifeart)
• #459 Fix file extension in docs (@elwayman02)
• #456 Fix doc typo (@elwayman02)
• #448 Document using standalone apps (@rwwagner90)

Committers: 6

• Alex Kanunnikov (@lifeart)
• Gabriel Csapo (@gabrielcsapo)
• Jordan Hawker (@elwayman02)
• Josemar Luedke (@josemarluedke)
• Kyle Turney (@kturney)
• Robert Wagner (@rwwagner90)

Change log

Releases (along with upgrade instructions) are documented on the Github Releases page.