Skip to content

Commit 5bb0e07

Browse files
Arsala Greyadamwathan
andauthored
Added docs for changing the default class name (#196)
* Added docs for changing the default class name * Update README.md Co-authored-by: Adam Wathan <[email protected]>
1 parent a34924b commit 5bb0e07

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -347,3 +347,29 @@ module.exports = {
347347
},
348348
}
349349
```
350+
351+
352+
### Changing the default class name
353+
354+
If you need to use a class name other than `prose` for any reason, you can do so using the `className` option when registering the plugin:
355+
356+
```js
357+
// tailwind.config.js
358+
module.exports = {
359+
theme: {
360+
// ...
361+
},
362+
plugins: [
363+
require('@tailwindcss/typography')({
364+
className: 'markdown',
365+
}),
366+
]
367+
...
368+
}
369+
```
370+
371+
```html
372+
<article class="markdown md:markdown-lg">
373+
{{ markdown }}
374+
</article>
375+
```

0 commit comments

Comments
 (0)