Skip to content

ember-learn/guidemaker-ember-template

Repository files navigation

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 documentation websites such as guides.emberjs.com, and cli.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.

Installation

ember install guidemaker-ember-template

Compatibility

  • Ember.js v3.28 or above
  • Embroider or ember-auto-import v2

Usage

[Longer description of how to use the addon in apps.]

Contributing

See the Contributing guide for details.

License

This project is licensed under the MIT License.