https://github.com/ember-learn/guidemaker-ember-template

Guidemaker template for Ember Guides websites
https://github.com/ember-learn/guidemaker-ember-template

ember emberjs hacktoberfest

Last synced: 2 days ago
JSON representation

Guidemaker template for Ember Guides websites

• Host: GitHub
• URL: https://github.com/ember-learn/guidemaker-ember-template
• Owner: ember-learn
• License: mit
• Created: 2018-07-27T06:22:04.000Z (about 6 years ago)
• Default Branch: main
• Last Pushed: 2024-08-11T13:14:02.000Z (about 2 months ago)
• Last Synced: 2024-09-26T11:37:35.203Z (7 days ago)
• Topics: ember, emberjs, hacktoberfest
• Language: JavaScript
• Homepage: https://guidemaker-ember-template.netlify.app/release
• Size: 5.79 MB
• Stars: 5
• Watchers: 13
• Forks: 21
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![This project uses GitHub Actions for continuous integration.](https://github.com/ember-learn/guidemaker-ember-template/workflows/CI/badge.svg)](https://github.com/ember-learn/guidemaker-ember-template/actions?query=workflow%3ACI)

[![This project uses Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/Ember/guidemaker-ember-template)

# guidemaker-ember-template

This addon provides the general layout and some styles that are used for documentation websites such as [guides.emberjs.com](https://guides.emberjs.com/release/), and [cli.emberjs.com](https://cli.emberjs.com/release/).

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](https://github.com/ember-learn/ember-styleguide), not this repository.

[guidemaker](https://github.com/empress/guidemaker) is what assembles guides content into queryable records.

[guides-source](https://github.com/ember-learn/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](CONTRIBUTING.md) guide for details.

## License

This project is licensed under the [MIT License](LICENSE.md).