Brunobkr/llama.cpp_AlgMor24_github

1<p>2  <a href="https://tailwindcss.com/docs/typography-plugin" target="_blank">3    <picture>4      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tailwindlabs/tailwindcss-typography/HEAD/.github/logo-dark.svg">5      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tailwindlabs/tailwindcss-typography/HEAD/.github/logo-light.svg">6      <img alt="Tailwind CSS Typography" src="https://raw.githubusercontent.com/tailwindlabs/tailwindcss-typography/HEAD/.github/logo-light.svg" width="450" height="70" style="max-width: 100%;">7    </picture>8  </a>9</p>10 11The official Tailwind CSS Typography plugin provides a set of `prose` classes you can use to add beautiful typographic defaults to any vanilla HTML you don’t control, like HTML rendered from Markdown, or pulled from a CMS.12 13```html14<article class="prose lg:prose-xl">{{ markdown }}</article>15```16 17To see what it looks like in action, check out our [live demo](https://play.tailwindcss.com/uj1vGACRJA?layout=preview) on Tailwind Play.18 19---20 21## Installation22 23Install the plugin from npm:24 25```shell26npm install -D @tailwindcss/typography27```28 29Then add the plugin to your `tailwind.config.js` file:30 31```js32/** @type {import('tailwindcss').Config} */33module.exports = {34  theme: {35    // ...36  },37  plugins: [38    require('@tailwindcss/typography'),39    // ...40  ],41}42```43 44---45 46## Basic usage47 48Now you can use the `prose` classes to add sensible typography styles to any vanilla HTML:49 50```html51<article class="prose lg:prose-xl">52  <h1>Garlic bread with cheese: What the science tells us</h1>53  <p>54    For years parents have espoused the health benefits of eating garlic bread with cheese to their55    children, with the food earning such an iconic status in our culture that kids will often dress56    up as warm, cheesy loaf for Halloween.57  </p>58  <p>59    But a recent study shows that the celebrated appetizer may be linked to a series of rabies cases60    springing up around the country.61  </p>62  <!-- ... -->63</article>64```65 66### Choosing a gray scale67 68This plugin includes a modifier class for each of the five gray scales Tailwind includes by default so you can easily style your content to match the grays you're using in your project.69 70```html71<article class="prose prose-slate">{{ markdown }}</article>72```73 74Here are the classes that are generated using a totally default Tailwind CSS v2.0 build:75 76| Class                    | Gray scale |77| ------------------------ | ---------- |78| `prose-gray` _(default)_ | Gray       |79| `prose-slate`            | Slate      |80| `prose-zinc`             | Zinc       |81| `prose-neutral`          | Neutral    |82| `prose-stone`            | Stone      |83 84Modifier classes are designed to be used with the [multi-class modifier pattern](http://nicolasgallagher.com/about-html-semantics-front-end-architecture/#component-modifiers) and must be used in conjunction with the base `prose` class.85 86> [!NOTE]87> Always include the `prose` class when adding a gray scale modifier88 89```html90<article class="prose prose-stone">{{ markdown }}</article>91```92 93To learn about creating your own color themes, read the [adding custom color themes](#adding-custom-color-themes) documentation.94 95### Applying a type scale96 97Size modifiers allow you to adjust the overall size of your typography for different contexts.98 99```html100<article class="prose prose-xl">{{ markdown }}</article>101```102 103Five different typography sizes are included out of the box:104 105| Class                    | Body font size    |106| ------------------------ | ----------------- |107| `prose-sm`               | 0.875rem _(14px)_ |108| `prose-base` _(default)_ | 1rem _(16px)_     |109| `prose-lg`               | 1.125rem _(18px)_ |110| `prose-xl`               | 1.25rem _(20px)_  |111| `prose-2xl`              | 1.5rem _(24px)_   |112 113These can be used in combination with Tailwind's [breakpoint modifiers](https://tailwindcss.com/docs/responsive-design) to change the overall font size of a piece of content at different viewport sizes:114 115```html116<article class="prose md:prose-lg lg:prose-xl">{{ markdown }}</article>117```118 119Everything about the provided size modifiers has been hand-tuned by professional designers to look as beautiful as possible, including the relationships between font sizes, heading spacing, code block padding, and more.120 121Size modifiers are designed to be used with the [multi-class modifier pattern](http://nicolasgallagher.com/about-html-semantics-front-end-architecture/#component-modifiers) and must be used in conjunction with the base `prose` class.122 123> [!NOTE]124> Always include the `prose` class when adding a size modifier125 126```html127<article class="prose prose-lg">{{ markdown }}</article>128```129 130To learn about customizing the included type scales, read the documentation on [customizing the CSS](#customizing-the-css).131 132### Adapting to dark mode133 134Each default color theme includes a hand-designed dark mode version that you can trigger by adding the `prose-invert` class:135 136```html137<article class="prose dark:prose-invert">{{ markdown }}</article>138```139 140To learn about creating your own color themes, read the [adding custom color themes](#adding-custom-color-themes) documentation.141 142### Element modifiers143 144Use element modifiers to customize the style of individual elements in your content directly in your HTML:145 146```html147<article class="prose prose-img:rounded-xl prose-headings:underline prose-a:text-blue-600">148  {{ markdown }}149</article>150```151 152This makes it easy to do things like style links to match your brand, add a border radius to images, and tons more.153 154Here's a complete list of available element modifiers:155 156| Modifier                     | Target                       |157| ---------------------------- | ---------------------------- |158| `prose-headings:{utility}`   | `h1`, `h2`, `h3`, `h4`, `th` |159| `prose-lead:{utility}`       | `[class~="lead"]`            |160| `prose-h1:{utility}`         | `h1`                         |161| `prose-h2:{utility}`         | `h2`                         |162| `prose-h3:{utility}`         | `h3`                         |163| `prose-h4:{utility}`         | `h4`                         |164| `prose-p:{utility}`          | `p`                          |165| `prose-a:{utility}`          | `a`                          |166| `prose-blockquote:{utility}` | `blockquote`                 |167| `prose-figure:{utility}`     | `figure`                     |168| `prose-figcaption:{utility}` | `figcaption`                 |169| `prose-strong:{utility}`     | `strong`                     |170| `prose-em:{utility}`         | `em`                         |171| `prose-kbd:{utility}`        | `kbd`                        |172| `prose-code:{utility}`       | `code`                       |173| `prose-pre:{utility}`        | `pre`                        |174| `prose-ol:{utility}`         | `ol`                         |175| `prose-ul:{utility}`         | `ul`                         |176| `prose-li:{utility}`         | `li`                         |177| `prose-table:{utility}`      | `table`                      |178| `prose-thead:{utility}`      | `thead`                      |179| `prose-tr:{utility}`         | `tr`                         |180| `prose-th:{utility}`         | `th`                         |181| `prose-td:{utility}`         | `td`                         |182| `prose-img:{utility}`        | `img`                        |183| `prose-video:{utility}`      | `video`                      |184| `prose-hr:{utility}`         | `hr`                         |185 186When stacking these modifiers with other modifiers like `hover`, you most likely want the other modifier to come first:187 188```html189<article class="prose prose-a:text-blue-600 hover:prose-a:text-blue-500">{{ markdown }}</article>190```191 192Read the Tailwind CSS documentation on [ordering stacked modifiers](https://tailwindcss.com/docs/hover-focus-and-other-states#ordering-stacked-modifiers) to learn more.193 194### Overriding max-width195 196Each size modifier comes with a baked in `max-width` designed to keep the content as readable as possible. This isn't always what you want though, and sometimes you'll want the content to just fill the width of its container.197 198In those cases, all you need to do is add `max-w-none` to your content to override the embedded max-width:199 200```html201<div class="grid grid-cols-4">202  <div class="col-span-1">203    <!-- ... -->204  </div>205  <div class="col-span-3">206    <article class="prose max-w-none">{{ markdown }}</article>207  </div>208</div>209```210 211---212 213## Advanced topics214 215### Undoing typography styles216 217If you have a block of markup embedded in some content that shouldn't inherit the `prose` styles, use the `not-prose` class to sandbox it:218 219```html220<article class="prose">221  <h1>My Heading</h1>222  <p>...</p>223 224  <div class="not-prose">225    <!-- Some example or demo that needs to be prose-free -->226  </div>227 228  <p>...</p>229  <!-- ... -->230</article>231```232 233Note that you can't nest new `prose` instances within a `not-prose` block at this time.234 235### Adding custom color themes236 237You can create your own color theme by adding a new key in the `typography` section of your `tailwind.config.js` file and providing your colors under the `css` key:238 239```js {{ filename: 'tailwind.config.js' }}240/** @type {import('tailwindcss').Config} */241module.exports = {242  theme: {243    extend: {244      typography: ({ theme }) => ({245        pink: {246          css: {247            '--tw-prose-body': theme('colors.pink[800]'),248            '--tw-prose-headings': theme('colors.pink[900]'),249            '--tw-prose-lead': theme('colors.pink[700]'),250            '--tw-prose-links': theme('colors.pink[900]'),251            '--tw-prose-bold': theme('colors.pink[900]'),252            '--tw-prose-counters': theme('colors.pink[600]'),253            '--tw-prose-bullets': theme('colors.pink[400]'),254            '--tw-prose-hr': theme('colors.pink[300]'),255            '--tw-prose-quotes': theme('colors.pink[900]'),256            '--tw-prose-quote-borders': theme('colors.pink[300]'),257            '--tw-prose-captions': theme('colors.pink[700]'),258            '--tw-prose-code': theme('colors.pink[900]'),259            '--tw-prose-pre-code': theme('colors.pink[100]'),260            '--tw-prose-pre-bg': theme('colors.pink[900]'),261            '--tw-prose-th-borders': theme('colors.pink[300]'),262            '--tw-prose-td-borders': theme('colors.pink[200]'),263            '--tw-prose-invert-body': theme('colors.pink[200]'),264            '--tw-prose-invert-headings': theme('colors.white'),265            '--tw-prose-invert-lead': theme('colors.pink[300]'),266            '--tw-prose-invert-links': theme('colors.white'),267            '--tw-prose-invert-bold': theme('colors.white'),268            '--tw-prose-invert-counters': theme('colors.pink[400]'),269            '--tw-prose-invert-bullets': theme('colors.pink[600]'),270            '--tw-prose-invert-hr': theme('colors.pink[700]'),271            '--tw-prose-invert-quotes': theme('colors.pink[100]'),272            '--tw-prose-invert-quote-borders': theme('colors.pink[700]'),273            '--tw-prose-invert-captions': theme('colors.pink[400]'),274            '--tw-prose-invert-code': theme('colors.white'),275            '--tw-prose-invert-pre-code': theme('colors.pink[300]'),276            '--tw-prose-invert-pre-bg': 'rgb(0 0 0 / 50%)',277            '--tw-prose-invert-th-borders': theme('colors.pink[600]'),278            '--tw-prose-invert-td-borders': theme('colors.pink[700]'),279          },280        },281      }),282    },283  },284  plugins: [285    require('@tailwindcss/typography'),286    // ...287  ],288}289```290 291See our internal [style definitions](https://github.com/tailwindlabs/tailwindcss-typography/blob/main/src/styles.js) for some more examples.292 293### Changing the default class name294 295If 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:296 297```js {{ filename: 'tailwind.config.js' }}298/** @type {import('tailwindcss').Config} */299module.exports = {300  theme: {301    // ...302  },303  plugins: [304    require('@tailwindcss/typography')({305      className: 'wysiwyg',306    }),307  ]308  ...309}310```311 312Now every instance of `prose` in the default class names will be replaced by your custom class name:313 314```html315<article class="wysiwyg wysiwyg-slate lg:wysiwyg-xl">316  <h1>My Heading</h1>317  <p>...</p>318 319  <div class="not-wysiwyg">320    <!-- Some example or demo that needs to be prose-free -->321  </div>322 323  <p>...</p>324  <!-- ... -->325</article>326```327 328### Customizing the CSS329 330If you want to customize the raw CSS generated by this plugin, add your overrides under the `typography` key in the `theme` section of your `tailwind.config.js` file:331 332```js {{ filename: 'tailwind.config.js' }}333/** @type {import('tailwindcss').Config} */334module.exports = {335  theme: {336    extend: {337      typography: {338        DEFAULT: {339          css: {340            color: '#333',341            a: {342              color: '#3182ce',343              '&:hover': {344                color: '#2c5282',345              },346            },347          },348        },349      },350    },351  },352  plugins: [353    require('@tailwindcss/typography'),354    // ...355  ],356}357```358 359Like with all theme customizations in Tailwind, you can also define the `typography` key as a function if you need access to the `theme` helper:360 361```js {{ filename: 'tailwind.config.js' }}362/** @type {import('tailwindcss').Config} */363module.exports = {364  theme: {365    extend: {366      typography: (theme) => ({367        DEFAULT: {368          css: {369            color: theme('colors.gray.800'),370 371            // ...372          },373        },374      }),375    },376  },377  plugins: [378    require('@tailwindcss/typography'),379    // ...380  ],381}382```383 384Customizations should be applied to a specific modifier like `DEFAULT` or `xl`, and must be added under the `css` property. Customizations are authored in the same [CSS-in-JS syntax](https://tailwindcss.com/docs/plugins#css-in-js-syntax) used to write Tailwind plugins.385 386See [the default styles](https://github.com/tailwindlabs/tailwindcss-typography/blob/main/src/styles.js) for this plugin for more in-depth examples of configuring each modifier.387 388---389 390## Community391 392For help, discussion about best practices, or any other conversation that would benefit from being searchable:393 394[Discuss the Tailwind CSS Typography plugin on GitHub](https://github.com/tailwindlabs/tailwindcss/discussions)395 396For casual chit-chat with others using the framework:397 398[Join the Tailwind CSS Discord Server](https://tailwindcss.com/discord)399