Stack Overflow
Stack Overflow

Questions tagged [react-styleguidist]

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component `propTypes` and shows live, editable usage examples based on Markdown files.

React Styleguidist is a component development environment with hot reloaded dev server and a living style guide that you can share with your team. It lists component propTypes and shows live, editable usage examples based on Markdown files.

85 questions
1
vote
1 answer

React-styleguardist - static assets?

I would like to use static asset in my documentation but I'm getting 404 My asset folder is on the root of the project under src/ and called static I have added this path in assetsDir in my styleguide.config.js const path =…
zapjelly
  • 75
  • 4
1
vote
0 answers

How can I show external file in a View Code block

I would like to show the source of another file within my Styleguidists MarkDown document. I do not want the source to be always visible inline; I'd like to only appear when the reader clicks on View Code. Per the documentation…
David Goldfarb
  • 1,796
  • 3
  • 18
  • 32
1
vote
1 answer

How to make react-styleguide to support show documentation for JSDoc params?

Whatever I'm doing I'm not able to generate docs for components that uses JSDoc. For e.g. The following code: /** * @param {{name:string}} props * */ export function Button(props) { } Should show me: To see the props I must use…
Aminadav Glickshtein
  • 23,232
  • 12
  • 77
  • 117
1
vote
0 answers

Is there a way to show a class mixin props in vue-styleguidist?

I'm working on a project using vuejs2 and the vue-class-component package to make the class components and using vue-styleguidist for documentation. For a certain scenario I had to create a Mixin and this is done via extending the component class…
Ishkar
  • 11
  • 2
1
vote
0 answers

How to styleguide your react components when using redux

I am using react, styleguidist and redux. I am trying to document different app states depending on redux store state, but the playground the .md file creates only uses one store. The .md file looks like this: import * as actions from…
Juan David Arce
  • 814
  • 8
  • 14
1
vote
0 answers

Styleguidist grouping components in one page

We have svg icons as components so the folder structure is kind of like components / -- icons -- Readme.md /-- Check -- Check.tsx -- index.ts /-- Cross -- Cross.tsx -- index.ts /-- Cloud --…
Yichz
  • 9,250
  • 10
  • 54
  • 92
1
vote
1 answer

react-styleguidist error for fresh react-create-app?

Trying to set up documentation for a react based project. Using a fresh 'my-app' from 'create-react-app' and a very naive *.js file I get an error: C:\xampp\htdocs\my-app2\node_modules\react-styleguidist\bin\styleguidist.js You can now view your…
gqstav
  • 1,984
  • 1
  • 12
  • 18
1
vote
1 answer

How to load ThemeProvide to Styleguidist?

I want to integrate my theme from styled-components to styleguidist. According official docs I've created ThemeWrapper and added this into config: ... const path = require('path'); const styleguideComponents = { Wrapper: path.join(__dirname,…
Gordienko R.
  • 331
  • 4
  • 16
1
vote
0 answers

Styleguidist: Failed to compile

After upgrading to latest version of react-styleguidist (7.2.3), I'm having some trouble compiling my js/jsx files. The error I'm getting is: FAIL Failed to compile. ./src/components/Forms/Fieldset/Fieldset.jsx) Module build failed (from…
Knut Sorknes
  • 13
  • 1
  • 4
1
vote
1 answer

Rect Styleguidist: Unexpected token import

I'm having a problem getting the webpack configuration inside the styleguide.config.js This is my styleguide.config.js: module.exports = { title: 'My Guide Project', components: 'src/components/**/[A-Z]*.js', showSidebar: true, …
dieh1984
  • 53
  • 8
1
vote
0 answers

How to load material-ui alike icons in react-styleguidist

I'm trying to load components from the src/components folder (which works perfectly) and also from the src/icons, which doesn't load anything: sections: [ { name: 'Components', components: path.join(__dirname,…
Joan Mira
  • 279
  • 1
  • 4
  • 9
1
vote
1 answer

Using styleguidist in a react native application

I'm trying to use styleguidist in a react native application application; I come across this link and implemented the exact same set up in my application: https://github.com/styleguidist/react-styleguidist/tree/master/examples/react-native After…
A.Chakroun
  • 261
  • 3
  • 17
1
vote
2 answers

Export react-styleguidist documentation

I am using simple comments which react-styleguidist exports to documentation. There is npx styleguidist server which runs it on server and npx styleguidist build which makes a bundle file. Is there any way I can export this documentation. For…
Igor-Vuk
  • 3,551
  • 7
  • 30
  • 65
1
vote
0 answers

use ExtendedPropTypes with styleguidelist

i am not able to use ExtendedPropTypes with styleguidelist getting error ./app/components/Common/Error/ErrorBoundary.js Module not found: Can't resolve 'extended-proptypes' in '/app/components/Common/Error'
user2224055
  • 41
  • 5
1
vote
0 answers

How to load local CSS with react-styleguidist 7 and Webpack 4

I want to load local 3rd party css (eg font-awesome icons) as part of my styleguide. As many components uses the same CSS, I want it to be loaded automatically and included as part of the static build. I settled on using mini-css-extract-plugin to…
bugzpodder
  • 29
  • 1
  • 6
1 2
3
4 5 6