Skip to content

Commit

Permalink
docs: update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Renato Moor committed Aug 30, 2022
1 parent 22d92d8 commit f5aafc5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 18 deletions.
12 changes: 4 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,15 @@ npm install storybook-tailwind-foundations

## Adapt `./storybook/main.js`
```js
const resolveConfig = require('tailwindcss/resolveConfig');
const tailwindConfig = require('../tailwind.config.js') // replace with your own config file location
const fullConfig = resolveConfig(tailwindConfig)
require('storybook-tailwind-foundations/initialize.js')
.default(resolve('../tailwind.config.js')); // or your own config file

module.exports = {
// ...
stories: [
// ...
'../node_modules/storybook-tailwind-foundations/**/*.stories.js'],
env: (config) => ({
...config,
STORYBOOK_TAILWIND: fullConfig,
}),
'../node_modules/storybook-tailwind-foundations/**/*.stories.js'
],
}
```

Expand Down
14 changes: 4 additions & 10 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
- Vue 3.0+
- Tailwind CSS
- Storybook
- Storybook builder vite

## Install package

Expand All @@ -15,20 +14,15 @@ npm install storybook-tailwind-fundations

## Adapt `./storybook/main.js`
```js
const sbTwConfigFoundations = require("../src/bin/config");
// initialize process
sbTwConfigFoundations.initialize()
require('storybook-tailwind-foundations/initialize.js')
.default(resolve('../tailwind.config.js')); // or your own config file

module.exports = {
// ...
stories: [
// ...
'../node_modules/storybook-tailwind-foundations/**/*.stories.js'],
env: (config) => ({
...config,
// access the config object
STORYBOOK_TAILWIND: sbTwConfigFoundations.getConfig(),
}),
'../node_modules/storybook-tailwind-foundations/**/*.stories.js'
],
}
```

Expand Down

0 comments on commit f5aafc5

Please sign in to comment.