tuchk4 / storybook-readme

React Storybook addon to render README files in github style

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Globally set defaultStyle of markdown

robbertolierook opened this issue · comments

At the moment the readme's in me storybook react project are styled pretty ugly, especially the props table, because it uses my custom storybook theme. Somehow the custom theme does not go well with the table. I want to use the defaultTheme for all the readme's as specified in the githubMarkdownCss.js file but I don't know how.

I can't seem to set any style globally though, although I have to say the docs are confusing. This one of the things I have be trying to just change the table background color:

config.js:

addDecorator(addReadme);

addParameters({
  options: {
    theme: myCustomTheme,
    panelPosition: 'right',
    readme: {
      theme: {tableTrBackgroundColor: '#fff',},
    }
  },
});

But then again, I preferably want to use the entire defaultTheme settings.
How do I do this?

Never mind I figured it out, except for my mistake to put 'readme' in the options param you need to change the original theme so storybook readme can do the rest, really vague though, I needed to search the source code. You might wanna consider updating your docs about that.

addParameters({
  options: {
    theme: myTheme,
    panelPosition: 'right',
  },
  readme: {
    theme: {
      textColor: '#333',
      appBg: '#f7f7f7',
      barBg: '#fff',
    },
  }
});