jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-11-25 07:05:52 +03:00
Code Issues Projects Releases Wiki Activity

Edit migration doc

Browse Source
This commit is contained in:
Brent Jackson 2020-02-12 10:22:37 -05:00
parent 41db111d64
commit f25b71afe8
4 changed files with 22 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -10,7 +10,7 @@
- **Deprecated:** Swipe gestures - to be replaced with new UI
- **Deprecated:** Title is no longer inferred from first heading
- **Deprecated:** `export const themes` has been removed - merge themes in a separate module if needed
- **Deprecated:** Functional themes are no longer supported, merge themse in a separate module if needed
- **Deprecated:** Functional themes are no longer supported, merge themes in a separate module if needed
- **Deprecated:** `theme.Provider` - use `Header` and `Footer` components instead
- **Deprecated:** Fixed aspect ratio has been removed
- Bug fixes

18
MIGRATION.md
View File

@ -1,6 +1,20 @@
# Migration
## Updating to MDX Deck v3
## Upgrading to MDX Deck v4
For simple decks, upgrading to v4 should not require any major changes and should help resolve an issue when making changes to a file while the development server is running.
- If you are using a custom `Provider` component, replace this component with the new `Header` and `Footer` components
- Note that some functionality previously available in the Provider component is no longer possible
- Replace any instance of the `Appear` component with the new `Steps` component. This should be a 1:1 change.
- The document title is no longer inferred from the first heading. Use the `Head` component with a `<title>` element instead.
- Merging multiple themes using `export const themes` is no longer supported. Merge themes in a separate file, if necessary.
- Functional themes are no longer supported.
- Fixed aspect ratio is no longer supported.
- Swipe gestures have been removed; these will be reintroduced in a later version.
- If you are using `gatsby-theme-mdx-deck` directly, no major changes have been made to this package.
## Upgrading to MDX Deck v3
- The `export default` syntax for slide layouts is no longer supported. Replace this syntax with the layout component wrapped around the slide content instead.
- The following packages have been deprecated. Import components directly from the `mdx-deck` package instead.
@ -22,7 +36,7 @@
[theme ui]: https://theme-ui.com
## Updating to MDX Deck v2
## Upgrading to MDX Deck v2
With a few exceptions, decks created with v1 should be compatible with v2. The following is a list of steps to ensure your slide deck will work with v2.

2
docs/demo.mdx
View File

@ -1,6 +1,4 @@
import Counter from './Counter'
import { themes } from 'mdx-deck'
<Head>
<title>MDX Deck</title>

5
packages/gatsby-plugin/package.json
View File

@ -13,6 +13,11 @@
"react": "^16.10.0",
"react-dom": "^16.10.0"
},
"devDependencies": {
"gatsby": "^2.14.0",
"react": "^16.10.0",
"react-dom": "^16.10.0"
},
"dependencies": {
"@mdx-js/loader": "^1.5.3",
"@mdx-js/mdx": "^1.5.3",