jxnblk/mdx-deck
1
1
Fork 0
mirror of https://github.com/jxnblk/mdx-deck.git synced 2024-09-20 19:37:27 +03:00
Code Issues Projects Releases Wiki Activity

Clarify that all colors keys are required for theming to work properly

Browse Source
This commit is contained in:
Carlos Filoteo 2018-10-17 17:03:46 -06:00
parent 321e3261ec
commit 4af7d225ef
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/theming.md
View File

@ -29,6 +29,8 @@ export { default as theme } from './theme'
The theme should be an object with fields for fonts, colors, and CSS for individual components. The theme should be an object with fields for fonts, colors, and CSS for individual components.
It's recommended that all custom themes extend the default theme as a base. It's recommended that all custom themes extend the default theme as a base.
<small>Note: you need to include [all keys](#reference) in the `colors` object for the theming to work correctly. You may want to use a deep [merge](https://www.npmjs.com/search?q=merge) strategy for extending existing themes more easily.</small>
```js ```js
// Example theme.js // Example theme.js
import theme from 'mdx-deck/themes' import theme from 'mdx-deck/themes'
@ -40,6 +42,7 @@ export default {
font: 'Roboto, sans-serif', font: 'Roboto, sans-serif',
// custom colors // custom colors
colors: { colors: {
...theme.colors, // include existing theme colors
text: '#f0f', text: '#f0f',
background: 'black', background: 'black',
link: '#0ff', link: '#0ff',