Questions tagged [styleguidist]

6 questions
4
votes
2 answers

How can I get React styleguidist to install correctly and get past the peer Dependency issues with react-simple-code-editor: React 16 & 17?

I am in the process of learning React by reading the Fullstack React book. My setup: node -v v14.15.3 npm -v 7.3.0 Following the styleguidist install guide I ran: npm -i -D webpack react-styleguidist This installed: webpack…
JGFMK
  • 8,425
  • 4
  • 58
  • 92
2
votes
0 answers

Can I configure Styleguidist to run a script before every build / doc refresh?

I'm using Styleguidist to magically document my React Components and it's great. I have a couple of non-component utility libraries that I doc using JSDoc, and at present I compile their docs to markdown (using jsdoc2md) and tell Styleguidist to…
Daniel Baird
  • 2,239
  • 1
  • 18
  • 24
1
vote
0 answers

Webpack aliases does not work in Vue Styleguidist

I am using Vue Styleguidist in a Nuxt.js project. Based on the Styleguidist and Webapack documents, I have configured my styleguide.config.js file and set some aliases: module.exports = { ... webpackConfig: { resolve: { …
Negar
  • 649
  • 1
  • 6
  • 9
0
votes
0 answers

react-styleguidist use of TS in examples in MD files

I would like to use TypeScript in Markdown files with React-Styleguidist, but I consistently encounter a SyntaxError. I would appreciate help in resolving this specific issue. Here are the steps I have taken: I set up a React project with…
0
votes
0 answers

How to create a wrapper for only a single specific component in styleguidist?

In the Styleguidist documentation I found the example for creating a wrapper that will wrap every one of my components. It looks something like this: styleguide.config.js: const path = require('path') module.exports = { ... …
Philipp Panik
  • 254
  • 1
  • 4
  • 15
0
votes
1 answer

React Functional Component - Styleguidist

I am using Styleguidist but unfortunately it ignores everything inside my functional components e.g: /** * Displays a pageable list of projects or a single (detailed) project if an ID is given via the router. * *…