From ff978d803c576dae83a713d142ca8fd27a3ffa92 Mon Sep 17 00:00:00 2001 From: Philipp Bosch Date: Mon, 13 Jul 2020 21:12:00 +0200 Subject: [PATCH] Fix some minor typos in the demo content I loved reading through this text! :-) btw: this is a tilde `~` --- demo/components/MarkdownSample.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/demo/components/MarkdownSample.mdx b/demo/components/MarkdownSample.mdx index bf07299..87e4b6e 100644 --- a/demo/components/MarkdownSample.mdx +++ b/demo/components/MarkdownSample.mdx @@ -11,7 +11,7 @@ We get lots of complaints about it actually, with people regularly asking us thi We hear you, but we're not convinced that simply disabling our base styles is what you really want. You don't want to have to remove annoying margins every time you use a `p` element in a piece of your dashboard UI. And I doubt you really want your blog posts to use the user-agent styles either — you want them to look _awesome_, not awful. -The `@tailwindcss/typography` plugin is our attempt to give you what you _actually_ want, without any of the downside of doing something stupid like disabling our base styles. +The `@tailwindcss/typography` plugin is our attempt to give you what you _actually_ want, without any of the downsides of doing something stupid like disabling our base styles. It adds a new `prose` class that you can slap on any block of vanilla HTML content and turn it into a beautiful, well-formatted document: @@ -31,7 +31,7 @@ It adds a new `prose` class that you can slap on any block of vanilla HTML conte ``` -For more information about how to use the plugin and the features it includes, [read the documentation](#). +For more information about how to use the plugin and the features it includes, [read the documentation](https://github.com/tailwindcss/typography/blob/master/README.md). --- @@ -80,9 +80,9 @@ And that's the end of this section. ### We should make sure that looks good, too. -Sometimes you have headings directly underneath each other. In those cases you have often have to undo the top margin on the second heading because it usually looks better for the headings to be closer together than a paragraph followed by a heading should be. +Sometimes you have headings directly underneath each other. In those cases you often have to undo the top margin on the second heading because it usually looks better for the headings to be closer together than a paragraph followed by a heading should be. -### When a heading comes after a paragraph... +### When a heading comes after a paragraph … When a heading comes after a paragraph, we need a bit more space, like I already mentioned above. Now let's see what a more complex list would look like. @@ -90,7 +90,7 @@ When a heading comes after a paragraph, we need a bit more space, like I already For some reason I think this looks cool which is unfortunate because it's pretty annoying to get the styles right. - I often have two or three paragraphs in these list items too, so the hard part is getting the spacing between the paragraphs, list item heading, and separate list items to all make sense. Pretty tough honestly, you could make a strong argument that you just shouldn't write this way. + I often have two or three paragraphs in these list items, too, so the hard part is getting the spacing between the paragraphs, list item heading, and separate list items to all make sense. Pretty tough honestly, you could make a strong argument that you just shouldn't write this way. - **Since this is a list, I need at least two items.** @@ -179,13 +179,13 @@ We also need to make sure inline code looks good, like if I wanted to talk about ### Sometimes I even use `code` in headings -Even though it's probably a bad idea, and historically I've had a hard time making it look good. This _"wrap the code blocks in tildes"_ trick works pretty well though really. +Even though it's probably a bad idea, and historically I've had a hard time making it look good. This _"wrap the code blocks in backticks"_ trick works pretty well though really. -Another thing I've done in the past is put a `code` tag inside of a link, like if I wanted to tell you about the [`tailwindcss/docs`](https://github.com/tailwindcss/docs) repository. I don't love that there is an underline below the tildes but it is absolutely not worth the madness it would require to avoid it. +Another thing I've done in the past is put a `code` tag inside of a link, like if I wanted to tell you about the [`tailwindcss/docs`](https://github.com/tailwindcss/docs) repository. I don't love that there is an underline below the backticks but it is absolutely not worth the madness it would require to avoid it. #### We haven't used an `h4` yet -But now we have. Please don't use `h5` or `h6` in your content, Medium only supports two heading levels for a reason you animals. I honestly considered using a `before` pseudo-element to scream at you if you use an `h5` or `h6`. +But now we have. Please don't use `h5` or `h6` in your content, Medium only supports two heading levels for a reason, you animals. I honestly considered using a `before` pseudo-element to scream at you if you use an `h5` or `h6`. We don't style them at all out of the box because `h4` elements are already so small that they are the same size as the body copy. What are we supposed to do with an `h5`, make it _smaller_ than the body copy? No thanks.