Skip to content

Commit

Permalink
Update README to add details about Embroider & YUIDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
Djamel BENDAOUD authored and dbendaou committed Dec 23, 2022
1 parent 5e69c43 commit 27bf1b4
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,8 +81,19 @@ So in order to add a script tag to the generated `preview-head.html` a potential
}
}
```

> It is important to note that storybook will by default serve any files out of the `public` folder. If you have custom files you would like to serve they need to exist there.
## Embroider & YUIDoc
If you want to use YUIDoc with Embroider, you will need to modify your `ember-cli-build.js` to be able to compile the documentation.

```diff
const { Webpack } = require('@embroider/webpack');
- return require('@embroider/compat').compatBuild(app, Webpack);
+ const compiledApp = require('@embroider/compat').compatBuild(app, Webpack);
+
+ return require('@storybook/ember-cli-storybook').prerender(app, compiledApp);
```

# Troubleshooting

### Components that need routing for query parameters
Expand Down

0 comments on commit 27bf1b4

Please sign in to comment.