Use the following tags and classes to write a better documentation.
All HTML headings, <h1>
through <h6>
, are available.
Copy Copy<h1>Heading 1</h1>
<h2>Heading 2</h2>
<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>
<h6>Heading 6</h6>
Create lighter, secondary text in any heading with a generic <small>
tag or the .small
class.
Copy Copy<h1>Heading 1 <small>Small text</small></h1>
<h2>Heading 2 <small>Small text</small></h2>
<h3>Heading 3 <small>Small text</small></h3>
<h4>Heading 4 <small>Small text</small></h4>
<h5>Heading 5 <small>Small text</small></h5>
<h6>Heading 6 <small>Small text</small></h6>
Use follwoing contextual classes to change color of your text.
Copy Copy<p>This is a normal paragraph without any contectual classes.</p>
<p class="txt-purple">A paragraph with .txt-purple class.</p>
<p class="txt-green">A paragraph with .txt-green class.</p>
<p class="txt-blue">A paragraph with .txt-blue class.</p>
<p class="txt-red">A paragraph with .txt-red class.</p>
<p class="txt-orange">A paragraph with .txt-orange class.</p>
<p class="txt-dark">A paragraph with .txt-dark class.</p>
<p class="txt-gray">A paragraph with .txt-gray class.</p>
<p class="txt-white bg-dark">A paragraph with .txt-white and .bg-dark class.</p>
This is a normal paragraph without any contectual classes.
A paragraph with .txt-purple class.
A paragraph with .txt-green class.
A paragraph with .txt-blue class.
A paragraph with .txt-red class.
A paragraph with .txt-orange class.
A paragraph with .txt-dark class.
A paragraph with .txt-gray class.
A paragraph with .txt-white and .bg-dark class.
Use follwoing contextual classes to change background color of your text.
Copy Copy<p>This is a normal paragraph without any contectual classes.</p>
<p class="bg-purple">A paragraph with .bg-purple class.</p>
<p class="bg-green">A paragraph with .bg-green class.</p>
<p class="bg-blue">A paragraph with .bg-blue class.</p>
<p class="bg-orange">A paragraph with .bg-orange class.</p>
<p class="bg-red">A paragraph with .bg-red class.</p>
<p class="bg-dark">A paragraph with .bg-dark class.</p>
<p class="bg-dark-light">A paragraph with .bg-dark-light class.</p>
<p class="bg-dark-lighter">A paragraph with .bg-dark-lighter class.</p>
<p class="bg-dark-lightest">A paragraph with .bg-dark-lightest class.</p>
<p class="bg-gray">A paragraph with .bg-gray class.</p>
<p class="bg-gray-light">A paragraph with .bg-gray-light class.</p>
<p class="bg-gray-lighter">A paragraph with .bg-gray-lighter class.</p>
<p class="bg-gray-lightest">A paragraph with .bg-gray-lightest class.</p>
<p class="bg-white">A paragraph with .bg-white class.</p>
This is a normal paragraph without any contectual classes.
A paragraph with .bg-purple class.
A paragraph with .bg-green class.
A paragraph with .bg-blue class.
A paragraph with .bg-orange class.
A paragraph with .bg-red class.
A paragraph with .bg-dark class.
A paragraph with .bg-dark-light class.
A paragraph with .bg-dark-lighter class.
A paragraph with .bg-dark-lightest class.
A paragraph with .bg-gray class.
A paragraph with .bg-gray-light class.
A paragraph with .bg-gray-lighter class.
A paragraph with .bg-gray-lightest class.
A paragraph with .bg-white class.
Use <mark>
tag or .highlight
class to highlight a text.
Copy Copy<p>A sample of <mark>marked</mark> text.</p>
<p>A sample of <span class="highlight">highlighted</span> text.</p>
A sample of marked text.
A sample of highlighted text.
Use <small>
tag or .small
class to make a paragraph smaller, or make a paragraph stand out by adding .lead
class.
Copy Copy<p class="lead">A sample lead paragraph.</p>
<p>A normal paragraph.</p>
<p class="small">A sample small paragraph.</p>
A sample lead paragraph.
A normal paragraph.
A sample small paragraph.
Wrap <blockquote>
around any HTML as the quote. For straight quotes, we recommend a <p>
.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
Copy Copy<blockquote>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
</blockquote>
html markup
Add a <footer>
for identifying the source. Wrap the name of the source work in <cite>
.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.
Copy Copy<blockquote>
<p>Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante.</p>
<footer>Someone famous in <cite title="Source Title">Source Title</cite></footer>
</blockquote>
html markup
Divide your paragraph to several columns using .text-cols-2
, .text-cols-3
, and .text-cols-4
classes.
<p class="text-cols-2">...</p>
<p class="text-cols-3">...</p>
<p class="text-cols-4">...</p>
html markup
Etiam efficitur bibendum nibh ut ultricies. Nulla luctus erat in risus tincidunt eleifend. Proin ornare mollis quam vitae faucibus. Suspendisse nisi lorem, venenatis vitae ligula et, tempor blandit nunc. Mauris eleifend sodales mauris, at rutrum diam. Duis sed odio molestie felis euismod rutrum placerat vitae risus. Cras lectus massa, ultricies at dui ac, commodo pulvinar velit. Fusce ultrices sem felis, vitae sodales justo tempus in. Etiam et sodales augue, a efficitur nibh. Vestibulum augue purus, rhoncus vitae enim a, ultrices gravida justo. Nunc mollis nibh ac arcu placerat, at sagittis libero sollicitudin. Etiam suscipit, magna non eleifend ornare, dui libero congue dui, id ultricies lacus ante vitae erat. Aliquam sollicitudin sem a est tempor, nec vehicula ipsum tempor. Interdum et malesuada fames ac ante ipsum primis in faucibus. Pellentesque ac risus ac arcu laoreet feugiat a sit amet libero. Aenean luctus, nisi ut tincidunt semper, purus sapien fringilla quam, a ultrices arcu dolor sed neque.
Etiam efficitur bibendum nibh ut ultricies. Nulla luctus erat in risus tincidunt eleifend. Proin ornare mollis quam vitae faucibus. Suspendisse nisi lorem, venenatis vitae ligula et, tempor blandit nunc. Mauris eleifend sodales mauris, at rutrum diam. Duis sed odio molestie felis euismod rutrum placerat vitae risus. Cras lectus massa, ultricies at dui ac, commodo pulvinar velit. Fusce ultrices sem felis, vitae sodales justo tempus in. Etiam et sodales augue, a efficitur nibh. Vestibulum augue purus, rhoncus vitae enim a, ultrices gravida justo. Nunc mollis nibh ac arcu placerat, at sagittis libero sollicitudin. Etiam suscipit, magna non eleifend ornare, dui libero congue dui, id ultricies lacus ante vitae erat. Aliquam sollicitudin sem a est tempor, nec vehicula ipsum tempor. Interdum et malesuada fames ac ante ipsum primis in faucibus. Pellentesque ac risus ac arcu laoreet feugiat a sit amet libero. Aenean luctus, nisi ut tincidunt semper, purus sapien fringilla quam, a ultrices arcu dolor sed neque.
Etiam efficitur bibendum nibh ut ultricies. Nulla luctus erat in risus tincidunt eleifend. Proin ornare mollis quam vitae faucibus. Suspendisse nisi lorem, venenatis vitae ligula et, tempor blandit nunc. Mauris eleifend sodales mauris, at rutrum diam. Duis sed odio molestie felis euismod rutrum placerat vitae risus. Cras lectus massa, ultricies at dui ac, commodo pulvinar velit. Fusce ultrices sem felis, vitae sodales justo tempus in. Etiam et sodales augue, a efficitur nibh. Vestibulum augue purus, rhoncus vitae enim a, ultrices gravida justo. Nunc mollis nibh ac arcu placerat, at sagittis libero sollicitudin. Etiam suscipit, magna non eleifend ornare, dui libero congue dui, id ultricies lacus ante vitae erat. Aliquam sollicitudin sem a est tempor, nec vehicula ipsum tempor. Interdum et malesuada fames ac ante ipsum primis in faucibus. Pellentesque ac risus ac arcu laoreet feugiat a sit amet libero. Aenean luctus, nisi ut tincidunt semper, purus sapien fringilla quam, a ultrices arcu dolor sed neque.
Split your documentation page to different parts and describe each of those inside a section tag.
You can see sample header almost in every section of this documentation. The header of this section uses following code:
Copy Copy<header class="section-header">
<span>Content decoupling</span>
<h2>Sections</h2>
<p>Split your documentation page to different parts and describe each of those inside a section tag.</p>
</header>
By default, the header is center aligned. But you can easily change the text alignment by using .text-left
or .text-right
with header tag.
Split your documentation page to different parts and describe each of those inside a section tag.
Copy Copy<header class="section-header text-left">
<span>Content decoupling</span>
<h2>Sections</h2>
<p>Split your documentation page to different parts and describe each of those inside a section tag.</p>
</header>
html markup
You have a plenty of option to modify background of a section.
By default, background-color is white, but you can use following classes with a section
tag to modify its background-color.
<section class="bg-gray-light">
...
</section>
Also, you can always change background-color using inline style:
<section style="background-color: #123456">
...
</section>
Easily add a background-image to a section using inline style:
<section style="background-image: url(path/to/image.png)">
...
</section>
Or take advantage of your assets/css/custom.css
file and make a class for each background-image:
.bg-img-sec-about {
background-image: url(../img/bg-about.png);
}
css css
<section class="bg-img-sec-about">
...
</section>
html markup
You can easily add a video to background of sections.
Copy Copy<section>
<video class="bg-video" autoplay loop>
<source src="assets/img/video.mp4" type="video/mp4">
<source src="assets/img/video.webm" type="video/webm">
</video>
</section>
It's always a good practice to accompany background images and videos with an overly class to make a better contrast between background and texts. You have .overlay-black
and .overlay-white
classes to use with sections. Also, you can increase or decrease their opacity by adding .overlay-intense
and .overlay-pale
respectively.
Here's some helper classes that you can add to any section to make a small change in it.
Class name | Description |
---|---|
.no-border-bottom |
Sections have an 1px border-bottom. Adding this class would remove the border. |
.section-sm |
By default, each section has 96px padding in top and bottom. This class will change it to 48px. |
.section-lg |
By default, each section has 96px padding in top and bottom. This class will change it to 164px. |
.bg-repeat |
This class can be useful when you're using a pattern-based background image and you'd like to repeat it all over the section. |
Also, you can use general helper classes as well.
Arange your data into rows and columns of cells
For basic styling—light padding and only horizontal dividers—add the base class .table
to any <table>
. It may seem super redundant, but given the widespread use of tables for other plugins like calendars and date pickers, we've opted to isolate our custom table styles.
Copy Copy<table class="table">
<thead>
<tr>
<th>#< /th>
<th>First Name< /th>
<th>Last Name< /th>
<th>Username< /th>
< /tr>
< /thead>
<tbody>
<tr>
<th scope="row">1< /th>
<td>Mark< /td>
<td>Otto< /td>
<td>@mdo< /td>
< /tr>
<tr>
<th scope="row">2< /th>
<td>Jacob< /td>
<td>Thornton< /td>
<td>@fat< /td>
< /tr>
<tr>
<th scope="row">3< /th>
<td>Larry< /td>
<td>the Bird< /td>
<td>@twitter< /td>
< /tr>
< /tbody>
< /table>
For more samples and documentation, please visit official Bootstrap documentation.
Options table can be used for describing a function, event, class, etc. Make sure you'll wrap your table indside .table-responsive
and your table has classes of .table
, .table-options
, .table-bordered
and .table-striped
.
You can use this type of table to describe several related key-value-paired options. Your table has to include these classes: .table
, .table-bordered
, .table-striped
and .table-info
.
Use any of the available form elements to create your forms to receive input from users.
Here's different variation of text inputs, textarea, and select to use.
Copy Copy<div class="form-group">
<input type="text" class="form-control">
< /div>
<div class="form-group">
<input type="text" class="form-control">
<span class="help-block">A block of help text...< /span>
< /div>
<div class="form-group">
<input type="text" class="form-control" placeholder="Placeholder">
< /div>
<div class="form-group">
<label for="input1">Label text< /label>
<input type="text" id="input1" class="form-control">
< /div>
Copy Copy<div class="form-group">
<input type="text" class="form-control input-sm" placeholder="Small">
< /div>
<div class="form-group">
<input type="text" class="form-control" placeholder="Normal">
< /div>
<div class="form-group">
<input type="text" class="form-control input-lg" placeholder="Big">
< /div>
Copy Copy<div class="form-group">
<select class="form-control">
<option>1< /option>
<option>2< /option>
<option>3< /option>
<option>4< /option>
<option>5< /option>
< /select>
< /div>
<div class="form-group">
<select multiple class="form-control">
<option>1< /option>
<option>2< /option>
<option>3< /option>
<option>4< /option>
<option>5< /option>
< /select>
< /div>
Copy Copy<div class="form-group">
<div class="input-group">
<span class="input-group-addon">@< /span>
<input type="text" class="form-control" placeholder="Username">
< /div>
< /div>
<div class="form-group">
<div class="input-group">
<input type="text" class="form-control" placeholder="Recipient's username">
<span class="input-group-addon">@example.com< /span>
< /div>
< /div>
<div class="form-group">
<div class="input-group">
<span class="input-group-addon">$< /span>
<input type="text" class="form-control" aria-label="Amount (to the nearest dollar)">
<span class="input-group-addon">.00< /span>
< /div>
< /div>
<div class="form-group">
<label for="basic-url">Your vanity URL< /label>
<div class="input-group">
<span class="input-group-addon">https://example.com/users/< /span>
<input type="text" class="form-control" id="basic-url">
< /div>
< /div>
Copy Copy<div class="checkbox">
<label>
<input type="checkbox" value="">
Option one
< /label>
< /div>
<div class="checkbox disabled">
<label>
<input type="checkbox" value="" disabled>
Option two is disabled
< /label>
< /div>
<div class="radio">
<label>
<input type="radio" name="optionsRadios" id="optionsRadios1" value="option1" checked>
Option one
< /label>
< /div>
<div class="radio">
<label>
<input type="radio" name="optionsRadios" id="optionsRadios2" value="option2">
Option two
< /label>
< /div>
<div class="radio disabled">
<label>
<input type="radio" name="optionsRadios" id="optionsRadios3" value="option3" disabled>
Option three is disabled
< /label>
< /div>
Copy Copy<label class="checkbox-inline">
<input type="checkbox" id="inlineCheckbox1" value="option1"> 1
< /label>
<label class="checkbox-inline">
<input type="checkbox" id="inlineCheckbox2" value="option2"> 2
< /label>
<label class="checkbox-inline">
<input type="checkbox" id="inlineCheckbox3" value="option3"> 3
< /label>
<label class="radio-inline">
<input type="radio" name="inlineRadioOptions" id="inlineRadio1" value="option1"> 1
< /label>
<label class="radio-inline">
<input type="radio" name="inlineRadioOptions" id="inlineRadio2" value="option2"> 2
< /label>
<label class="radio-inline">
<input type="radio" name="inlineRadioOptions" id="inlineRadio3" value="option3"> 3
< /label>
Highlight part of your text by placing it inside a .label
class
Add any of the below mentioned modifier classes to change the appearance of a label.
Copy Copy<span class="label label-primary">Primary< /span>
<span class="label label-success">Success< /span>
<span class="label label-info">Info< /span>
<span class="label label-warning">Warning< /span>
<span class="label label-danger">Danger< /span>
<span class="label label-dark">Dark< /span>
html markup
Bold, graphic, and intentional imagery helps to engage the user
Add classes to an <img>
element to easily style images in any project.
<img class="img-rounded" src="assets/img/placeholder.png" alt="image">
<img class="img-circle" src="assets/img/placeholder.png" alt="image">
<img class="img-thumbnail" src="assets/img/placeholder.png" alt="image">
html markup
Add a small shadow usign .img-shadow
class.
<img class="img-shadow" src="assets/img/placeholder.png" alt="image">
<figure>
<img src="assets/img/placeholder.png" alt="image">
<figcaption>some description about the image< /figcaption>
< /figure>
Some other helper classes in addition to Bootstrap's helper classes
Class name | Description |
---|---|
.no-padding |
Equals to padding: 0; |
.no-padding-x |
Equals to padding-left: 0; padding-right: 0; |
.no-padding-y |
Equals to padding-top: 0; padding-bottom: 0; |
.no-padding-top |
Equals to padding-top: 0; |
.no-padding-bottom |
Equals to padding-bottom: 0; |