hacks-guide-minimal-mistake.../docs/_docs/15-utility-classes.md
Michael Rose 866fb17d9e Toggle table of contents via front matter (#1310)
* Add jekyll-toc include
* Reduce whitespace generated by comments
* Add table of contents include to `single` layout
* Replace `toc` include with jekyll-toc enabled YAML Front Matter
* Update README
* Update table of contents documentation
  - Revise `toc` helper include to mention that it will be deprecated in the next major version.
  - Add documentation to `single` layout explaining how to enable table of contents on those pages.
* Update CHANGELOG and history
* Update LICENSE

Close #1222
2017-10-20 14:54:06 -04:00

6.2 KiB
Raw Blame History

title permalink excerpt last_modified_at toc toc_label toc_icon
Utility Classes /docs/utility-classes/ CSS classes for aligning text/image, styling buttons and notices, and more. 2017-10-20T12:36:34-04:00 true Utility Classes gears

Using the Kramdown Markdown renderer with Jekyll allows you to add block and inline attributes. This is nice if you want to add custom styling to text and image, and still write in Markdown.

Jekyll 3: Kramdown is the default for jekyll new sites and those hosted on GitHub Pages. Not using Kramdown? That's OK. The following classes are still available when used with standard HTML. {: .notice--warning}

Text Alignment

Align text blocks with the following classes.

Left aligned text .text-left {: .text-left}

Left aligned text
{: .text-left}

Center aligned text. .text-center {: .text-center}

Center aligned text.
{: .text-center}

Right aligned text. .text-right {: .text-right}

Right aligned text.
{: .text-right}

Justified text. .text-justify Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque vel eleifend odio, eu elementum purus. In hac habitasse platea dictumst. Fusce sed sapien eleifend, sollicitudin neque non, faucibus est. Proin tempus nisi eu arcu facilisis, eget venenatis eros consequat. {: .text-justify}

Justified text.
{: .text-justify}

No wrap text. .text-nowrap {: .text-nowrap}

No wrap text.
{: .text-nowrap}

Image Alignment

Position images with the following classes.

![image-center]({{ "/assets/images/image-alignment-580x300.jpg" | absolute_url }}){: .align-center}

The image above happens to be centered.

![image-center](/assets/images/filename.jpg){: .align-center}

![image-left]({{ "/assets/images/image-alignment-150x150.jpg" | absolute_url }}){: .align-left} The rest of this paragraph is filler for the sake of seeing the text wrap around the 150×150 image, which is left aligned. There should be plenty of room above, below, and to the right of the image. Just look at him there --- Hey guy! Way to rock that left side. I don't care what the right aligned image says, you look great. Don't let anyone else tell you differently.

![image-left](/assets/images/filename.jpg){: .align-left}

![image-right]({{ "/assets/images/image-alignment-300x200.jpg" | absolute_url }}){: .align-right}

And now we're going to shift things to the right align. Again, there should be plenty of room above, below, and to the left of the image. Just look at him there --- Hey guy! Way to rock that right side. I don't care what the left aligned image says, you look great. Don't let anyone else tell you differently.

![image-right](/assets/images/filename.jpg){: .align-right}

![full]({{ "/assets/images/image-alignment-1200x4002.jpg" | absolute_url }}) {: .full}

The image above should extend outside of the parent container on right.

![full](/assets/images/filename.jpg)
{: .full}

Buttons

Make any link standout more when applying the .btn .btn--primary classes.

<a href="#" class="btn btn--primary">Link Text</a>
Button Type Example Class Kramdown
Default Text{: .btn} .btn [Text](#link){: .btn}
Primary Text{: .btn .btn--primary} .btn .btn--primary [Text](#link){: .btn .btn--primary}
Success Text{: .btn .btn--success} .btn .btn--success [Text](#link){: .btn .btn--success}
Warning Text{: .btn .btn--warning} .btn .btn--warning [Text](#link){: .btn .btn--warning}
Danger Text{: .btn .btn--danger} .btn .btn--danger [Text](#link){: .btn .btn--danger}
Info Text{: .btn .btn--info} .btn .btn--info [Text](#link){: .btn .btn--info}
Inverse Text{: .btn .btn--inverse} .btn .btn--inverse [Text](#link){: .btn .btn--inverse}
Light Outline Text{: .btn .btn--light-outline} .btn .btn--light-outline [Text](#link){: .btn .btn--light-outline}
Button Size Example Class Kramdown
X-Large X-Large Button{: .btn .btn--primary .btn--x-large} .btn .btn--primary .btn--x-large [Text](#link){: .btn .btn--primary .btn--x-large}
Large Large Button{: .btn .btn--primary .btn--large} .btn .btn--primary .btn--large [Text](#link){: .btn .btn--primary .btn--large}
Default Default Button{: .btn .btn--primary} .btn .btn--primary [Text](#link){: .btn .btn--primary }
Small Small Button{: .btn .btn--primary .btn--small} .btn .btn--primary .btn--small [Text](#link){: .btn .btn--primary .btn--small}

Notices

Call attention to a block of text.

Notice Type Class
Default .notice
Primary .notice--primary
Info .notice--info
Warning .notice--warning
Success .notice--success
Danger .notice--danger

Watch out! This paragraph of text has been emphasized with the {: .notice} class. {: .notice}

Watch out! This paragraph of text has been emphasized with the {: .notice--primary} class. {: .notice--primary}

Watch out! This paragraph of text has been emphasized with the {: .notice--info} class. {: .notice--info}

Watch out! This paragraph of text has been emphasized with the {: .notice--warning} class. {: .notice--warning}

Watch out! This paragraph of text has been emphasized with the {: .notice--success} class. {: .notice--success}

Watch out! This paragraph of text has been emphasized with the {: .notice--danger} class. {: .notice--danger}

{% capture notice-text %} You can also add the .notice class to a <div> element.

  • Bullet point 1
  • Bullet point 2 {% endcapture %}

Notice Headline:

{{ notice-text | markdownify }}