guidemaker-ember-template

The default blueprint for ember-cli addons.

Usage no npm install needed!

<script type="module">
  import guidemakerEmberTemplate from 'https://cdn.skypack.dev/guidemaker-ember-template';
</script>

README

This project uses GitHub Actions for continuous integration. This project uses Percy.io for visual regression testing.

guidemaker-ember-template

This addon provides the general layout and some styles that are used for guides.emberjs.com.

Its responsibilities include:

  • CSS for the sidebar
  • HTML markup specifics (i.e. the classes that go on various divs in the text of the guide itself)

Related apps

Most aspects of the Guides are styled via ember-styleguide, not this repository.

guidemaker is what assembles guides content into queryable records.

guides-source has the learning content itself.

Compatibility

  • Ember.js v3.13 or above
  • Ember CLI v2.13 or above
  • Node.js v8 or above

Installation

ember install guidemaker-ember-template

Usage

See guides-source for an example of how to use this addon.

Contributing

See the Contributing guide for details.

Releases

To release a new version of this addon:

git checkout master
git pull origin master
npm install -g np
np

This command will run checks and tests, and ask you what version you want to do the release as (major, minor, patch).

License

This project is licensed under the MIT License.