Skip to content

Commit 51dbd8b

Browse files
Docs: Update sidebar order and text (#1256)
* Update docs sidebar order * Changeset for docs * Fix unrelated lint issue on broadcast channel.
1 parent 337d614 commit 51dbd8b

File tree

9 files changed

+27
-16
lines changed

9 files changed

+27
-16
lines changed

.changeset/swift-bears-grow.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'spectacle-docs': minor
3+
---
4+
5+
Updated the order of the sidebar items.

docs/api-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: API Reference
3-
order: 5
4-
sidebar_position: 5
3+
order: 4
4+
sidebar_position: 4
55
---
66

77
# API Reference

docs/extensions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Extensions
3-
order: 7
4-
sidebar_position: 7
3+
order: 8
4+
sidebar_position: 8
55
---
66

77
# Third Party Extensions

docs/faq.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: FAQ
3-
order: 8
4-
sidebar_position: 8
3+
order: 9
4+
sidebar_position: 9
55
---
66

77
# Frequently Asked Questions

docs/props.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Base Props
3-
order: 3
4-
sidebar_position: 3
3+
order: 5
4+
sidebar_position: 5
55
---
66

77
# Base Props

docs/slide-layouts.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
import Full from '../website/static/img/slide-layouts/full.png';
1+
---
2+
title: Slide Layouts
3+
order: 6
4+
sidebar_position: 6
5+
---
26

7+
import Full from '../website/static/img/slide-layouts/full.png';
38

49
## SlideLayout
510

@@ -225,4 +230,4 @@ A layout with an image that covers the entire slide.
225230
| `imgContainerProps` | `ComponentProps<typeof FlexBox>` || `{ style: { border: '8px solid white' } }` |
226231
| `objectFit` | `React.CSSProperties['objectFit']` || `cover` |
227232

228-
![Full bleed image layout example slide](../website/static/img/slide-layouts/fullBleed.png)
233+
![Full bleed image layout example slide](../website/static/img/slide-layouts/fullBleed.png)

docs/themes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Themes
3-
order: 4
4-
sidebar_position: 4
3+
order: 7
4+
sidebar_position: 7
55
---
66

77
# Theme System

docs/tutorial.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: Getting Started
3-
order: 6
4-
sidebar_position: 6
3+
order: 3
4+
sidebar_position: 3
55
---
66

77
# Getting Started with Spectacle: A Tutorial

packages/spectacle/src/hooks/use-broadcast-channel.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ import { DeckView } from './use-deck-state';
55

66
const noop = () => {};
77
let safeWindow: any = {};
8-
if (typeof window !== "undefined") {
8+
if (typeof window !== 'undefined') {
99
safeWindow = window;
1010
}
11-
const BroadcastChannel = safeWindow.BroadcastChannel || BroadcastChannelPolyfill;
11+
const BroadcastChannel =
12+
safeWindow.BroadcastChannel || BroadcastChannelPolyfill;
1213

1314
type MessageCallback = (message: MessageTypes) => void;
1415

0 commit comments

Comments
 (0)