Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify template creation #156

Merged
merged 2 commits into from
Sep 26, 2024
Merged

Clarify template creation #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4a8a0ac
Clarify template creation
agnetemoos Sep 18, 2024
3ab8c23
Updated changelog and fixed github actions issue
tuj Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/pr.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ jobs:

- name: Archive screenshots
if: ${{ failure() }}
uses: actions/upload-artifact@v2
uses: actions/upload-artifact@v4
with:
name: cypress-screenhosts-${{ matrix.browser }}
path: cypress/screenshots
Expand Down
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ All notable changes to this project will be documented in this file.

## [Unreleased]

- [#156](https://github.com/os2display/display-templates/pull/156)
- Clarified template creation.
- [#155](https://github.com/os2display/display-templates/pull/155)
- Added single-booking layout to calendar template.
- Removed defaultProps.
Expand Down
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ To add a template:
* `my-template-content-example.json` - An example content.
* `my-template-schema.json` - Json Schema description of the content for the slide.

Also add one or more entries to `src/slides.js` with examples of the data required for the template.
Add one or more entries to `src/slides.js` with examples of the data required for the template.

To compile the template it is necessary to add it to the webpack setup.
Also import the template in `src/index.js` and add the template to `const renderSlide = {}` in `src/index.js`.

To compile the template it is necessary to add it to the webpack setup. This is done in `webpack.config.js`.

Add it to `const entry = {}`:

Expand Down
Loading