diff --git a/_config.yml b/_config.yml index ff0a6616ac..0f704fe2f1 100644 --- a/_config.yml +++ b/_config.yml @@ -1,8 +1,6 @@ markdown: rdiscount permalink: pretty pygments: true -paginate: 5 - source: ./docs destination: ./_gh_pages auto: true diff --git a/docs/_includes/colophon.html b/docs/_includes/colophon.html new file mode 100644 index 0000000000..ae92db140c --- /dev/null +++ b/docs/_includes/colophon.html @@ -0,0 +1,35 @@ + + \ No newline at end of file diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html new file mode 100644 index 0000000000..c91c7d00ed --- /dev/null +++ b/docs/_includes/footer.html @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/_includes/header.html b/docs/_includes/header.html new file mode 100644 index 0000000000..ea590ca707 --- /dev/null +++ b/docs/_includes/header.html @@ -0,0 +1,44 @@ + + + + + + + {% if page.title == "Bootstrap" %} + {{ page.title }} + {% else if %} + {{ page.title }} · Bootstrap + {% endif %} + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/_includes/masthead.html b/docs/_includes/masthead.html new file mode 100644 index 0000000000..205b244fee --- /dev/null +++ b/docs/_includes/masthead.html @@ -0,0 +1,8 @@ +{% raw %} +
+
+

{{ page.title }}

+

{{ page.description }}

+
+
+{% endraw %} \ No newline at end of file diff --git a/docs/_includes/navbar.html b/docs/_includes/navbar.html new file mode 100644 index 0000000000..b9d5f02792 --- /dev/null +++ b/docs/_includes/navbar.html @@ -0,0 +1,37 @@ + +
+
+ + Bootstrap +
+ +
+
+
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 90e8af4405..536dae1ba2 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -1,173 +1,23 @@ - - - - - - - {% if page.title == "Bootstrap" %} - {{ page.title }} - {% else if %} - {{ page.title }} · Bootstrap - {% endif %} - - - - - - - - - - - - - - - - - - - - + + {% include header.html %} + - - -
-
- - Bootstrap -
- -
-
-
+ + {% include navbar.html %} + + {{ content }} -{{ content }} + + {% include colophon.html %} - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + {% include footer.html %} - + \ No newline at end of file diff --git a/docs/_layouts/example.html b/docs/_layouts/example.html new file mode 100644 index 0000000000..4814401245 --- /dev/null +++ b/docs/_layouts/example.html @@ -0,0 +1,17 @@ + + + + + {% include header.html %} + + + + + + {{ content }} + + + {% include footer.html %} + + + \ No newline at end of file diff --git a/docs/assets/css/docs.css b/docs/assets/css/docs.css index c4e3645594..c45eb01b90 100644 --- a/docs/assets/css/docs.css +++ b/docs/assets/css/docs.css @@ -485,6 +485,21 @@ input.focused { overflow: auto; } +.highlight { + margin-bottom: 14px; + padding: 14px; + border-radius: 5px; +} +.highlight pre { + padding: 0; + margin-bottom: 0; + background-color: transparent; + border: 0; +} +.highlight pre code { + color: #ccc; +} + /* Docs gallery diff --git a/docs/assets/css/pygments_monokai.css b/docs/assets/css/pygments_monokai.css new file mode 100644 index 0000000000..6ad9714108 --- /dev/null +++ b/docs/assets/css/pygments_monokai.css @@ -0,0 +1,60 @@ +.highlight .hll { background-color: #49483e } +.highlight { background: #272822; color: #f8f8f2 } +.highlight .c { color: #75715e } /* Comment */ +.highlight .err { color: #960050; background-color: #1e0010 } /* Error */ +.highlight .k { color: #66d9ef } /* Keyword */ +.highlight .l { color: #ae81ff } /* Literal */ +.highlight .n { color: #f8f8f2 } /* Name */ +.highlight .o { color: #f92672 } /* Operator */ +.highlight .p { color: #f8f8f2 } /* Punctuation */ +.highlight .cm { color: #75715e } /* Comment.Multiline */ +.highlight .cp { color: #75715e } /* Comment.Preproc */ +.highlight .c1 { color: #75715e } /* Comment.Single */ +.highlight .cs { color: #75715e } /* Comment.Special */ +.highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .gs { font-weight: bold } /* Generic.Strong */ +.highlight .kc { color: #66d9ef } /* Keyword.Constant */ +.highlight .kd { color: #66d9ef } /* Keyword.Declaration */ +.highlight .kn { color: #f92672 } /* Keyword.Namespace */ +.highlight .kp { color: #66d9ef } /* Keyword.Pseudo */ +.highlight .kr { color: #66d9ef } /* Keyword.Reserved */ +.highlight .kt { color: #66d9ef } /* Keyword.Type */ +.highlight .ld { color: #e6db74 } /* Literal.Date */ +.highlight .m { color: #ae81ff } /* Literal.Number */ +.highlight .s { color: #e6db74 } /* Literal.String */ +.highlight .na { color: #a6e22e } /* Name.Attribute */ +.highlight .nb { color: #f8f8f2 } /* Name.Builtin */ +.highlight .nc { color: #a6e22e } /* Name.Class */ +.highlight .no { color: #66d9ef } /* Name.Constant */ +.highlight .nd { color: #a6e22e } /* Name.Decorator */ +.highlight .ni { color: #f8f8f2 } /* Name.Entity */ +.highlight .ne { color: #a6e22e } /* Name.Exception */ +.highlight .nf { color: #a6e22e } /* Name.Function */ +.highlight .nl { color: #f8f8f2 } /* Name.Label */ +.highlight .nn { color: #f8f8f2 } /* Name.Namespace */ +.highlight .nx { color: #a6e22e } /* Name.Other */ +.highlight .py { color: #f8f8f2 } /* Name.Property */ +.highlight .nt { color: #f92672 } /* Name.Tag */ +.highlight .nv { color: #f8f8f2 } /* Name.Variable */ +.highlight .ow { color: #f92672 } /* Operator.Word */ +.highlight .w { color: #f8f8f2 } /* Text.Whitespace */ +.highlight .mf { color: #ae81ff } /* Literal.Number.Float */ +.highlight .mh { color: #ae81ff } /* Literal.Number.Hex */ +.highlight .mi { color: #ae81ff } /* Literal.Number.Integer */ +.highlight .mo { color: #ae81ff } /* Literal.Number.Oct */ +.highlight .sb { color: #e6db74 } /* Literal.String.Backtick */ +.highlight .sc { color: #e6db74 } /* Literal.String.Char */ +.highlight .sd { color: #e6db74 } /* Literal.String.Doc */ +.highlight .s2 { color: #e6db74 } /* Literal.String.Double */ +.highlight .se { color: #ae81ff } /* Literal.String.Escape */ +.highlight .sh { color: #e6db74 } /* Literal.String.Heredoc */ +.highlight .si { color: #e6db74 } /* Literal.String.Interpol */ +.highlight .sx { color: #e6db74 } /* Literal.String.Other */ +.highlight .sr { color: #e6db74 } /* Literal.String.Regex */ +.highlight .s1 { color: #e6db74 } /* Literal.String.Single */ +.highlight .ss { color: #e6db74 } /* Literal.String.Symbol */ +.highlight .bp { color: #f8f8f2 } /* Name.Builtin.Pseudo */ +.highlight .vc { color: #f8f8f2 } /* Name.Variable.Class */ +.highlight .vg { color: #f8f8f2 } /* Name.Variable.Global */ +.highlight .vi { color: #f8f8f2 } /* Name.Variable.Instance */ +.highlight .il { color: #ae81ff } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/docs/getting-started.html b/docs/getting-started.html index 6ef0606377..742dc466f6 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -1,6 +1,7 @@ --- layout: default title: Getting started +description: Overview of the project, its contents, and how to get started with a simple template. --- -
-
- -
-
+ +
+
+ +
+
- -
-
-

1. Download

+ +
+
+

1. Download

+
+

Before downloading, be sure to have a code editor (we recommend Sublime Text 2) and some working knowledge of HTML and CSS. We won't walk through the source files here, but they are available for download. We'll focus on getting started with the compiled Bootstrap files.

+ +
+
+

Download compiled

+

Fastest way to get started: get the compiled and minified versions of our CSS, JS, and images. No docs or original source files.

+

Download Bootstrap

-

Before downloading, be sure to have a code editor (we recommend Sublime Text 2) and some working knowledge of HTML and CSS. We won't walk through the source files here, but they are available for download. We'll focus on getting started with the compiled Bootstrap files.

- -
-
-

Download compiled

-

Fastest way to get started: get the compiled and minified versions of our CSS, JS, and images. No docs or original source files.

-

Download Bootstrap

-
-
-

Download source

-

Get the original files for all CSS and JavaScript, along with a local copy of the docs by downloading the latest version directly from GitHub.

-

Download Bootstrap source

-
+
+

Download source

+

Get the original files for all CSS and JavaScript, along with a local copy of the docs by downloading the latest version directly from GitHub.

+

Download Bootstrap source

-
+
+
- -
-
-

2. File structure

-
-

Within the download you'll find the following file structure and contents, logically grouping common assets and providing both compiled and minified variations.

-

Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:

-
+      
+      

+        

+          
2. File structure

+        

+        
Within the download you'll find the following file structure and contents, logically grouping common assets and providing both compiled and minified variations.

+        
Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:

+
+{% highlight bash %}
   bootstrap/
   ├── css/
   │   ├── bootstrap.css
@@ -78,172 +80,177 @@ title: Getting started
       ├── glyphiconshalflings-regular.svg
       ├── glyphiconshalflings-regular.ttf
       └── glyphiconshalflings-regular.woff
-
-

This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). The image files are compressed using ImageOptim, a Mac app for compressing PNGs.

-

Please note that all JavaScript plugins require jQuery to be included.

-
+{% endhighlight %} + +

This is the most basic form of Bootstrap: compiled files for quick drop-in usage in nearly any web project. We provide compiled CSS and JS (bootstrap.*), as well as compiled and minified CSS and JS (bootstrap.min.*). The image files are compressed using ImageOptim, a Mac app for compressing PNGs.

+

Please note that all JavaScript plugins require jQuery to be included.

+ - -
-
-

3. What's included

-
-

Bootstrap comes equipped with HTML, CSS, and JS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the Bootstrap documentation.

+ +
+
+

3. What's included

+
+

Bootstrap comes equipped with HTML, CSS, and JS for all sorts of things, but they can be summarized with a handful of categories visible at the top of the Bootstrap documentation.

-

Docs sections

-

In addition to the getting started documentation you're reading now, the Bootstrap docs are broken into a few key pages.

+

Docs sections

+

In addition to the getting started documentation you're reading now, the Bootstrap docs are broken into a few key pages.

-

Core CSS

-

Global styles for the body, Normalize, links, grid system, tables, forms, buttons, icons, and more.

-

Components

-

Basic styles for common interface components like tabs and pills, navbar, alerts, page headers, and more. Head here to see what kind of custom components Bootstrap has to offer beyond basic HTML elements.

-

JavaScript plugins

-

Similar to Components, these JavaScript plugins are interactive components for things like tooltips, popovers, modals, and more.

-
+

Core CSS

+

Global styles for the body, Normalize, links, grid system, tables, forms, buttons, icons, and more.

+

Components

+

Basic styles for common interface components like tabs and pills, navbar, alerts, page headers, and more. Head here to see what kind of custom components Bootstrap has to offer beyond basic HTML elements.

+

JavaScript plugins

+

Similar to Components, these JavaScript plugins are interactive components for things like tooltips, popovers, modals, and more.

+
- -
-
-

4. Basic HTML template

-
-

With a brief intro into the contents out of the way, we can focus on putting Bootstrap to use. To do that, we'll utilize a basic HTML template that includes everything we mentioned in the File structure.

-

Now, here's a look at a typical HTML file:

-
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Bootstrap 101 Template</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  </head>
-  <body>
-    <h1>Hello, world!</h1>
-    <script src="http://code.jquery.com/jquery.js"></script>
-  </body>
-</html>
-
-

To make this a Bootstrapped template, just include the appropriate CSS and JS files:

-
-<!DOCTYPE html>
-<html>
-  <head>
-    <title>Bootstrap 101 Template</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <!-- Bootstrap -->
-    <link href="css/bootstrap.min.css" rel="stylesheet" media="screen">
-  </head>
-  <body>
-    <h1>Hello, world!</h1>
-    <script src="http://code.jquery.com/jquery.js"></script>
-    <script src="js/bootstrap.min.js"></script>
-  </body>
-</html>
-
-

And you're set! With those two files added, you can begin to develop any site or application with Bootstrap.

+ +
+
+

4. Basic HTML template

+
+

With a brief intro into the contents out of the way, we can focus on putting Bootstrap to use. To do that, we'll utilize a basic HTML template that includes everything we mentioned in the File structure.

+

Now, here's a look at a typical HTML file:

-
+{% highlight html linenos %} + + + + Bootstrap 101 Template + + + +

Hello, world!

+ + + +{% endhighlight %} -

Responsive features in IE8

-

Internet Explorer 8 lacks support for media queries, the method by which we deliver responsive CSS to folks. To enable that, you need to include a third party tool (which we include in the project repository) called Respond.js.

+

To make this a Bootstrapped template, just include the appropriate CSS and JS files:

+ +{% highlight html linenos %} + + + + Bootstrap 101 Template + + + + + +

Hello, world!

+ + + + +{% endhighlight %} + +

And you're set! With those two files added, you can begin to develop any site or application with Bootstrap.

+ +
+ +

Responsive features in IE8

+

Internet Explorer 8 lacks support for media queries, the method by which we deliver responsive CSS to folks. To enable that, you need to include a third party tool (which we include in the project repository) called Respond.js.

 <!--[if lt IE 9]>
   <script src="/assets/js/respond/respond.js"></script>
 <![endif]-->
-
+
- -
-
-

5. Examples

+ +
+
+

5. Examples

+
+

Move beyond the base template with a few example layouts. We encourage folks to iterate on these examples and not simply use them as an end result.

+
+
+ + + +

Starter template

+

A barebones HTML document with all the Bootstrap CSS and JavaScript included.

-

Move beyond the base template with a few example layouts. We encourage folks to iterate on these examples and not simply use them as an end result.

-
-
- - - -

Starter template

-

A barebones HTML document with all the Bootstrap CSS and JavaScript included.

-
-
- - - -

Basic marketing site

-

Featuring a hero unit for a primary message and three supporting elements.

-
-
- - - -

Narrow marketing

-

Slim, lightweight marketing template for small projects or teams.

-
-
- - - -

Justified nav

-

Marketing page with equal-width navigation links in a modified navbar.

-
-
- - - -

Sign in

-

Barebones sign in form with custom, larger form controls and a flexible layout.

-
-
- - - -

Sticky footer

-

Pin a fixed-height footer to the bottom of the user's viewport.

-
-
- - - -

Sticky footer w/ navbar

-

Add a fixed navbar to the default sticky footer template.

-
-
- - - -

Carousel jumbotron

-

An interactive riff on the basic marketing site featuring a prominent carousel.

-
+
+ + + +

Basic marketing site

+

Featuring a hero unit for a primary message and three supporting elements.

-
- - - - - -
-
-

What next?

+
+ + + +

Narrow marketing

+

Slim, lightweight marketing template for small projects or teams.

-

Head to the docs for information, examples, and code snippets, or take the next leap and customize Bootstrap for any upcoming project.

- Visit the Bootstrap docs - Customize Bootstrap -
+
+ + + +

Justified nav

+

Marketing page with equal-width navigation links in a modified navbar.

+
+
+ + + +

Sign in

+

Barebones sign in form with custom, larger form controls and a flexible layout.

+
+
+ + + +

Sticky footer

+

Pin a fixed-height footer to the bottom of the user's viewport.

+
+
+ + + +

Sticky footer w/ navbar

+

Add a fixed navbar to the default sticky footer template.

+
+
+ + + +

Carousel jumbotron

+

An interactive riff on the basic marketing site featuring a prominent carousel.

+
+
+
-
-
+ +
+
+

What next?

+
+

Head to the docs for information, examples, and code snippets, or take the next leap and customize Bootstrap for any upcoming project.

+ Visit the Bootstrap docs + Customize Bootstrap +
-
+ + + +
+ + +