Skip to content

Commit

Permalink
[ci skip] Update docs: Fix spelling about View Transitions → `View …
Browse files Browse the repository at this point in the history
…Transition`
  • Loading branch information
yhatt committed Jan 19, 2025
1 parent 5e09ff4 commit 7315c2f
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@

### Breaking

- [Experimental transition] Adopt the latest spec of [View Transitions](https://www.w3.org/TR/css-view-transitions-1/) that is available in Chrome 109 and later ([#447](https://github.com/marp-team/marp-cli/issues/447), [#483](https://github.com/marp-team/marp-cli/issues/483), [#489](https://github.com/marp-team/marp-cli/pull/489))
- [Experimental transition] Adopt the latest spec of [View Transition](https://www.w3.org/TR/css-view-transitions-1/) that is available in Chrome 109 and later ([#447](https://github.com/marp-team/marp-cli/issues/447), [#483](https://github.com/marp-team/marp-cli/issues/483), [#489](https://github.com/marp-team/marp-cli/pull/489))

### Changed

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -375,10 +375,10 @@ The `bespoke` template is using [Bespoke.js](https://github.com/bespokejs/bespok
- **Fragmented list**: Recognize [Marpit's fragmented list](https://github.com/marp-team/marpit/issues/145) and appear list one-by-one if used `*` and `1)` as the bullet marker.
- **Presenter view**: Open presenter view in external window by hitting <kbd>p</kbd> key. (It may become disabled when not fulfilled requirements for working)
- **Progress bar** (optional): By setting `--bespoke.progress` option, you can add a progress bar on the top of the deck.
- [**Slide transitions**][transitions]: Support transitions (`transition` local directive) powered by [View Transitions API].
- [**Slide transitions**][transitions]: Support transitions (`transition` local directive) powered by [View Transition API].

[transitions]: ./docs/bespoke-transitions/README.md
[view transitions api]: https://www.w3.org/TR/css-view-transitions-1/
[view transition api]: https://www.w3.org/TR/css-view-transitions-1/

#### Docs

Expand Down Expand Up @@ -647,7 +647,7 @@ If you want to prevent looking up a configuration file, you can pass `--no-confi
| `bespoke` | object | | Setting options for `bespoke` template |
|`osc` | boolean | `--bespoke.osc` | \[Bespoke\] Use on-screen controller (`true` by default) |
|`progress` | boolean | `--bespoke.progress` | \[Bespoke\] Use progress bar (`false` by default) |
|`transition` | boolean | `--bespoke.transition` | \[Bespoke\] Use [transitions] (Only in browsers supported [View Transitions API]: `true` by default) |
|`transition` | boolean | `--bespoke.transition` | \[Bespoke\] Use [transitions] (Only in browsers supported [View Transition API]: `true` by default) |
| `browser` | string \| string[] | `--browser` | The kind of browser for conversion (`auto` by default) |
| `browserPath` | string | `--browser-path` | Path to the browser executable |
| `browserProtocol` | `cdp` \| `webdriver-bidi` | `--browser-protocol` | Set the preferred protocol for connecting to the browser (`cdp` by default) |
Expand Down
10 changes: 5 additions & 5 deletions docs/bespoke-transitions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,18 @@ Marp CLI's `bespoke` HTML template supports **slide transition animations**, tha

## Prerequisite

The slide transition depends on **[View Transitions] API** in the using browser. _We does never lock in to a specific JavaScript library_, as same as other Marp ecosystem projects :)
The slide transition depends on **[View Transition] API** in the using browser. _We does never lock in to a specific JavaScript library_, as same as other Marp ecosystem projects :)

To show transition animations, a viewer has to show HTML slide in the browser which have supported View Transitions.
To show transition animations, a viewer has to show HTML slide in the browser which have supported View Transition.

[view transitions]: https://www.w3.org/TR/css-view-transitions-1/
[view transition]: https://www.w3.org/TR/css-view-transitions-1/

### Supported browsers

- **Chrome**: ✅ (111-)
- **Edge**: ✅ (111-)
- **Safari**: ✅ (18.2- / [#572](https://github.com/marp-team/marp-cli/issues/572))
- **Firefox**: :x:
- **Safari**: Testable in [Safari Technology Preview 192](https://webkit.org/blog/15260/release-notes-for-safari-technology-preview-192/) and later

## `transition` local directive

Expand Down Expand Up @@ -491,7 +491,7 @@ If you want to swap the order of layers during animation, try to animate `z-inde
## Morphing animations

View Transitions API also provides smooth moving animation during the transition, for specific two elements before and after the transition. It gives a very similar effect to PowerPoint's Morph transition and Keynote's Magic Move, just by simple CSS declarations.
View Transition API also provides smooth moving animation during the transition, for specific two elements before and after the transition. It gives a very similar effect to PowerPoint's Morph transition and Keynote's Magic Move, just by simple CSS declarations.

If there were marked elements with the same name by [`view-transition-name` CSS property][view-transition-name] in a old page and new page between transition, the `bespoke` template will apply morphing animation automatically.

Expand Down
2 changes: 1 addition & 1 deletion src/marp-cli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -290,7 +290,7 @@ export const marpCli = async (
},
'bespoke.transition': {
describe:
'[Bespoke] Use transitions (Only in browsers supported View Transitions API)',
'[Bespoke] Use transitions (Only in browsers supported View Transition API)',
defaultDescription: 'true',
group: OptionGroup.Template,
type: 'boolean',
Expand Down
4 changes: 2 additions & 2 deletions src/templates/bespoke/bespoke.scss
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ $progress-height: 5px;

@media (prefers-reduced-motion: reduce) {
* {
/* Disable view transitions declared by users */
/* Disable view transition declared by users */
view-transition-name: none !important;
}
}
Expand Down Expand Up @@ -109,7 +109,7 @@ $progress-height: 5px;
/* Hack for Chrome to show OSC overlay onto video correctly */
will-change: transform;

/* View Transitions */
/* View Transition */
view-transition-name: __bespoke_marp_transition_osc__;

> * {
Expand Down

0 comments on commit 7315c2f

Please sign in to comment.