Skip to content

Commit 78bbb66

Browse files
committed
Finish initial draft of the config docs
1 parent b414ac5 commit 78bbb66

File tree

1 file changed

+66
-56
lines changed

1 file changed

+66
-56
lines changed

defaultConfig.js

Lines changed: 66 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ View the full documentation at https://tailwindcss.com.
1818
| The default config
1919
|-------------------------------------------------------------------------------
2020
|
21-
| This variable contains the default Tailwind config. You don't have to
22-
| use it, but it can sometimes be helpful to have available. For
21+
| This variable contains the default Tailwind config. You don't have
22+
| to use it, but it can sometimes be helpful to have available. For
2323
| example, you may choose to merge your custom configuration
2424
| values with some of the Tailwind defaults.
2525
|
@@ -218,10 +218,10 @@ module.exports = {
218218
| Text sizes https://tailwindcss.com/docs/text-sizes
219219
|-----------------------------------------------------------------------------
220220
|
221-
| Here is where you define your text sizes. These will be available as
222-
| .text-{size} utilities. Name these in whatever way makes the most
223-
| sense to you. We use size names by default, but you're welcome to
224-
| use a numeric scale or even something else entirely.
221+
| Here is where you define your text sizes. Name these in whatever way
222+
| makes the most sense to you. We use size names by default, but
223+
| you're welcome to use a numeric scale or even something else
224+
| entirely.
225225
|
226226
| By default Tailwind uses the "rem" unit type for most measurements.
227227
| This allows you to set a root font size which all other sizes are
@@ -249,11 +249,10 @@ module.exports = {
249249
| Font weights https://tailwindcss.com/docs/font-weights
250250
|-----------------------------------------------------------------------------
251251
|
252-
| Here is where you define your font weights. These will be available as
253-
| .font-{weight} utilities. We've provided a list of common font weight
254-
| names with their respective numeric scale values to get you started.
255-
| It's unlikely that your project will require all of these, so we
256-
| recommend removing those you don't need.
252+
| Here is where you define your font weights. We've provided a list of
253+
| common font weight names with their respective numeric scale values
254+
| to get you started. It's unlikely that your project will require
255+
| all of these, so we recommend removing those you don't need.
257256
|
258257
| Class name: .font-{weight}
259258
|
@@ -277,8 +276,8 @@ module.exports = {
277276
| Leading (line height) https://tailwindcss.com/docs/text-leading
278277
|-----------------------------------------------------------------------------
279278
|
280-
| Here is where you define your line height values, or as we call them
281-
| in Tailwind, leadings.
279+
| Here is where you define your line height values, or as we call
280+
| them in Tailwind, leadings.
282281
|
283282
| Class name: .leading-{size}
284283
|
@@ -297,8 +296,8 @@ module.exports = {
297296
| Tracking (letter spacing) https://tailwindcss.com/docs/text-tracking
298297
|-----------------------------------------------------------------------------
299298
|
300-
| Here is where you define your letter spacing values, or as we call them
301-
| in Tailwind, tracking.
299+
| Here is where you define your letter spacing values, or as we call
300+
| them in Tailwind, tracking.
302301
|
303302
| Class name: .tracking-{size}
304303
|
@@ -316,8 +315,8 @@ module.exports = {
316315
| Text colors https://tailwindcss.com/docs/text-colors
317316
|-----------------------------------------------------------------------------
318317
|
319-
| Here is where you define your text colors. By default these use the color
320-
| palette we defined above, however you're welcome to set these
318+
| Here is where you define your text colors. By default these use the
319+
| color palette we defined above, however you're welcome to set these
321320
| independently if that makes sense for your project.
322321
|
323322
| Class name: .text-{color}
@@ -332,9 +331,9 @@ module.exports = {
332331
| Background colors https://tailwindcss.com/docs/background-colors
333332
|-----------------------------------------------------------------------------
334333
|
335-
| Here is where you define your background colors. By default these use the
336-
| color palette we defined above, however you're welcome to set these
337-
| independently if that makes sense for your project.
334+
| Here is where you define your background colors. By default these use
335+
| the color palette we defined above, however you're welcome to set
336+
| these independently if that makes sense for your project.
338337
|
339338
| Class name: .bg-{color}
340339
|
@@ -348,9 +347,9 @@ module.exports = {
348347
| Border widths https://tailwindcss.com/docs/border-widths
349348
|-----------------------------------------------------------------------------
350349
|
351-
| Here is where you define your border widths. Take note that border widths
352-
| require a special "default" value set as well. This is the width that
353-
| will be used when you do not specify a border color.
350+
| Here is where you define your border widths. Take note that border
351+
| widths require a special "default" value set as well. This is the
352+
| width that will be used when you do not specify a border color.
354353
|
355354
| Class name: .border{-side?}{-width?}
356355
|
@@ -374,9 +373,9 @@ module.exports = {
374373
| color palette we defined above, however you're welcome to set these
375374
| independently if that makes sense for your project.
376375
|
377-
| Take note that border colors require a special "default" value set as
378-
| well. This is the color that will be used when you do not specify a
379-
| border color.
376+
| Take note that border colors require a special "default" value set
377+
| as well. This is the color that will be used when you do not
378+
| specify a border color.
380379
|
381380
| Class name: .border-{color}
382381
|
@@ -390,8 +389,8 @@ module.exports = {
390389
| Border radius https://tailwindcss.com/docs/border-radius
391390
|-----------------------------------------------------------------------------
392391
|
393-
| Here is where you define your border radius values. Take note that a
394-
| default radius is required. This is the value used when you use the
392+
| Here is where you define your border radius values. Take note that
393+
| a default radius is required. This is the value used for the
395394
| non-suffixed version of this utility (.rounded).
396395
|
397396
| Class name: .rounded-{radius?}
@@ -411,15 +410,16 @@ module.exports = {
411410
| Width https://tailwindcss.com/docs/width
412411
|-----------------------------------------------------------------------------
413412
|
414-
| Here is where you define your width utility sizes. These can be percentage
415-
| based, pixels, rems, or any other units. By default we provide a sensible
416-
| rem based numeric scale, a percentage based fraction scale, plus some
417-
| other common use-cases like "full" and "screen". You can, of course,
418-
| modify these values as needed.
413+
| Here is where you define your width utility sizes. These can be
414+
| percentage based, pixels, rems, or any other units. By default
415+
| we provide a sensible rem based numeric scale, a percentage
416+
| based fraction scale, plus some other common use-cases. You
417+
| can, of course, modify these values as needed.
419418
|
420-
| It's also worth mentioning that Tailwind automatically escapes invalid
421-
| CSS class name characters, which allows you to have awesome classes
422-
| like .w-2/3.
419+
|
420+
| It's also worth mentioning that Tailwind automatically escapes
421+
| invalid CSS class name characters, which allows you to have
422+
| awesome classes like .w-2/3.
423423
|
424424
| Class name: .w-{size}
425425
|
@@ -462,10 +462,11 @@ module.exports = {
462462
| Height https://tailwindcss.com/docs/height
463463
|-----------------------------------------------------------------------------
464464
|
465-
| Here is where you define your height utility sizes. These can be percentage
466-
| based, pixels, rems, or any other units. By default we provide a sensible
467-
| rem based numeric scale plus some other common use-cases like "full" and
468-
| "screen". You can, of course, modify these values as needed.
465+
| Here is where you define your height utility sizes. These can be
466+
| percentage based, pixels, rems, or any other units. By default
467+
| we provide a sensible rem based numeric scale plus some other
468+
| common use-cases. You can, of course, modify these values as
469+
| needed.
469470
|
470471
| Class name: .h-{size}
471472
|
@@ -497,10 +498,10 @@ module.exports = {
497498
| Minimum width https://tailwindcss.com/docs/min-width
498499
|-----------------------------------------------------------------------------
499500
|
500-
| Here is where you define your minimum width utility sizes. These can be
501-
| percentage based, pixels, rems, or any other units. We provide a couple
502-
| common use-cases by default. You can, of course, modify these values
503-
| as needed.
501+
| Here is where you define your minimum width utility sizes. These can
502+
| be percentage based, pixels, rems, or any other units. We provide a
503+
| couple common use-cases by default. You can, of course, modify
504+
| these values as needed.
504505
|
505506
| Class name: .min-w-{size}
506507
|
@@ -517,10 +518,10 @@ module.exports = {
517518
| Minimum height https://tailwindcss.com/docs/min-height
518519
|-----------------------------------------------------------------------------
519520
|
520-
| Here is where you define your minimum height utility sizes. These can be
521-
| percentage based, pixels, rems, or any other units. We provide a few
522-
| common use-cases by default. You can, of course, modify these values
523-
| as needed.
521+
| Here is where you define your minimum height utility sizes. These can
522+
| be percentage based, pixels, rems, or any other units. We provide a
523+
| few common use-cases by default. You can, of course, modify these
524+
| values as needed.
524525
|
525526
| Class name: .min-h-{size}
526527
|
@@ -668,16 +669,21 @@ module.exports = {
668669
| Shadows https://tailwindcss.com/docs/shadows
669670
|-----------------------------------------------------------------------------
670671
|
671-
| Add...
672+
| Here is where you define your shadow utilities. As you can see from
673+
| the defaults we provide, it's possible to apply multiple shadows
674+
| per utility using comma separation.
672675
|
673-
| Class name: .shadow-{size}
676+
| Take note that a default shadow is required. This is the value used
677+
| for the non-suffixed version of this utility (.shadow).
678+
|
679+
| Class name: .shadow-{size?}
674680
|
675681
*/
676682

677683
shadows: {
678684
default: '0 1px 3px rgba(0,0,0,.08), 0 1px 2px rgba(0,0,0,.15)',
679-
'md': ['0 3px 6px rgba(0,0,0,.12)', '0 3px 6px rgba(0,0,0,.13)'],
680-
'lg': ['0 10px 20px rgba(0,0,0,.13)', '0 6px 6px rgba(0,0,0,.13)'],
685+
'md': '0 3px 6px rgba(0,0,0,.12), 0 3px 6px rgba(0,0,0,.13)',
686+
'lg': '0 10px 20px rgba(0,0,0,.13), 0 6px 6px rgba(0,0,0,.13)',
681687
'inner': 'inset 0 1px 2px rgba(0, 0, 0, 0.05)',
682688
'none': 'none',
683689
},
@@ -688,7 +694,9 @@ module.exports = {
688694
| Z-index https://tailwindcss.com/docs/z-index
689695
|-----------------------------------------------------------------------------
690696
|
691-
| Add...
697+
| Here is where you define your z-index utility values. By default we
698+
| provide a sensible numeric scale. You can, of course, modify these
699+
| values as needed.
692700
|
693701
| Class name: .z-{name}
694702
|
@@ -710,7 +718,9 @@ module.exports = {
710718
| Opacity https://tailwindcss.com/docs/opacity
711719
|-----------------------------------------------------------------------------
712720
|
713-
| Add...
721+
| Here is where you define your opacity utility values. By default we
722+
| provide a sensible numeric scale. You can, of course, modify these
723+
| values as needed.
714724
|
715725
| Class name: .opacity-{name}
716726
|
@@ -732,8 +742,8 @@ module.exports = {
732742
|
733743
| Here is where you can define the configuration for any Tailwind packages
734744
| you're using. These can be utility packs, component bundles, or even
735-
| complete themes. You'll want to reference each package's documentation
736-
| for a list of settings available for it.
745+
| complete themes. You'll want to reference each package's
746+
| documentation for a list of settings available for it.
737747
|
738748
*/
739749

0 commit comments

Comments
 (0)