mirror of
https://github.com/jxnblk/mdx-deck.git
synced 2024-10-26 07:37:23 +03:00
Update template
This commit is contained in:
parent
edd43c6070
commit
358b029a03
21
README.md
21
README.md
@ -100,7 +100,7 @@ MDX can use Markdown syntax and render React components with JSX.
|
||||
|
||||
### Imports
|
||||
|
||||
To import components, use ES import syntax separated with empty lines from any markdown or JSX syntax.
|
||||
To import components, use ES import syntax separated with empty lines between any markdown or JSX syntax.
|
||||
|
||||
```mdx
|
||||
import { Box } from 'grid-styled'
|
||||
@ -112,7 +112,7 @@ Read more about MDX syntax in the [MDX Docs][mdx].
|
||||
|
||||
## Theming
|
||||
|
||||
mdx-deck uses [styled-components][] for styling, making practically any part of the presentation themeable.
|
||||
mdx-deck uses [emotion][] for styling, making practically any part of the presentation themeable.
|
||||
|
||||
### Built-in Themes
|
||||
|
||||
@ -200,7 +200,8 @@ export default ({ children }) => (
|
||||
width: '100vw',
|
||||
height: '100vw',
|
||||
backgroundColor: 'tomato',
|
||||
}}>
|
||||
}}
|
||||
>
|
||||
{children}
|
||||
</div>
|
||||
)
|
||||
@ -335,22 +336,14 @@ See more exporting options in the [Exporting Documentation](docs/exporting.md)
|
||||
### Related
|
||||
|
||||
- [MDX][]
|
||||
- [mdx-go][]
|
||||
- [ok-mdx][]
|
||||
- [Compositor x0][]
|
||||
- [styled-components][]
|
||||
- [styled-system][]
|
||||
- [emotion][]
|
||||
- [Spectacle][]
|
||||
|
||||
[MIT License](LICENSE.md)
|
||||
|
||||
[mdx]: https://github.com/mdx-js/mdx
|
||||
[ok-mdx]: https://github.com/jxnblk/ok-mdx
|
||||
[compositor x0]: https://github.com/c8r/x0
|
||||
[styled-system]: https://github.com/jxnblk/styled-system
|
||||
[styled-components]: https://github.com/styled-components/styled-components
|
||||
[mdx]: https://mdxjs.com/
|
||||
[spectacle]: https://github.com/FormidableLabs/spectacle
|
||||
[mdx-go]: https://github.com/jxnblk/mdx-go
|
||||
[emotion]: https://emotion.sh
|
||||
|
||||
<!-- examples -->
|
||||
|
||||
|
@ -3,6 +3,7 @@
|
||||
"version": "2.0.0-0",
|
||||
"workspaces": [
|
||||
"packages/*",
|
||||
"templates/*",
|
||||
"docs"
|
||||
],
|
||||
"scripts": {
|
||||
|
@ -27,7 +27,9 @@
|
||||
"@emotion/core": "^10.0.7",
|
||||
"@emotion/styled": "^10.0.7",
|
||||
"@mdx-deck/components": "^2.0.0-0",
|
||||
"@mdx-deck/layouts": "^2.0.0-0",
|
||||
"@mdx-deck/loader": "^2.0.0-0",
|
||||
"@mdx-deck/themes": "^2.0.0-0",
|
||||
"@mdx-deck/webpack-html-plugin": "^2.0.0-0",
|
||||
"@mdx-js/mdx": "^1.0.0-alpha.5",
|
||||
"@mdx-js/tag": "^1.0.0-alpha.5",
|
||||
|
@ -1,4 +1,3 @@
|
||||
|
||||
# mdx-deck basic template
|
||||
|
||||
This was generated with [mdx-deck][]'s `npm init deck` command.
|
||||
@ -21,18 +20,6 @@ To build the presentation deck as static HTML:
|
||||
npm run build
|
||||
```
|
||||
|
||||
To export a PDF:
|
||||
|
||||
```sh
|
||||
npm run pdf
|
||||
```
|
||||
|
||||
To export an image of the title slide:
|
||||
|
||||
```sh
|
||||
npm run image
|
||||
```
|
||||
|
||||
For more documentation see the [mdx-deck][] repo.
|
||||
|
||||
[mdx-deck]: https://github.com/jxnblk/mdx-deck
|
||||
|
@ -1,6 +1,6 @@
|
||||
import { Head } from 'mdx-deck'
|
||||
import { Head, Notes } from 'mdx-deck'
|
||||
|
||||
export { default as theme } from './theme'
|
||||
export { theme } from './theme'
|
||||
|
||||
<Head>
|
||||
<title>Presentation Title</title>
|
||||
@ -14,9 +14,9 @@ export { default as theme } from './theme'
|
||||
|
||||
To create your presentation
|
||||
|
||||
```notes
|
||||
- Create speaker notes in fenced code blocks
|
||||
```
|
||||
<Notes>
|
||||
Create speaker notes with the Notes component
|
||||
</Notes>
|
||||
|
||||
---
|
||||
|
||||
|
@ -1,13 +1,13 @@
|
||||
{
|
||||
"private": true,
|
||||
"name": "@mdx-deck/basic-template",
|
||||
"version": "2.0.0-0",
|
||||
"scripts": {
|
||||
"start": "mdx-deck deck.mdx",
|
||||
"build": "mdx-deck build deck.mdx",
|
||||
"pdf": "mdx-deck pdf deck.mdx",
|
||||
"image": "mdx-deck screenshot deck.mdx",
|
||||
"help": "mdx-deck"
|
||||
},
|
||||
"devDependencies": {
|
||||
"mdx-deck": "^1.6.7"
|
||||
"mdx-deck": "^2.0.0-0"
|
||||
}
|
||||
}
|
||||
|
@ -1,12 +1,7 @@
|
||||
import theme from 'mdx-deck/themes'
|
||||
|
||||
export default {
|
||||
...theme,
|
||||
|
||||
export const theme = {
|
||||
// Customize your presentation theme here.
|
||||
//
|
||||
// Read the docs for more info:
|
||||
// https://github.com/jxnblk/mdx-deck/blob/master/docs/theming.md
|
||||
// https://github.com/jxnblk/mdx-deck/blob/master/docs/themes.md
|
||||
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user