From e76d1677cbc3f11f167758d68b93aeaa8af2c23a Mon Sep 17 00:00:00 2001 From: Mark Otto Date: Mon, 10 Aug 2015 12:47:02 -0700 Subject: [PATCH] move containers.md to overview.md, merge in media queries as new section --- docs/_data/nav.yml | 6 +-- docs/layout/containers.md | 23 --------- docs/layout/media-queries.md | 72 -------------------------- docs/layout/overview.md | 97 ++++++++++++++++++++++++++++++++++++ 4 files changed, 99 insertions(+), 99 deletions(-) delete mode 100644 docs/layout/containers.md delete mode 100644 docs/layout/media-queries.md create mode 100644 docs/layout/overview.md diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml index 50e8f792f1..c460a64259 100644 --- a/docs/_data/nav.yml +++ b/docs/_data/nav.yml @@ -18,11 +18,9 @@ - title: Layout pages: - - title: Scaffolding - - title: Media queries - - title: Containers + - title: Overview - title: Grid - - title: Media + - title: Media object - title: Responsive utilities - title: Content diff --git a/docs/layout/containers.md b/docs/layout/containers.md deleted file mode 100644 index 2ab53446fb..0000000000 --- a/docs/layout/containers.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: Containers -group: layout ---- - -Bootstrap requires a containing element to wrap site contents and house our grid system. Choose from the fixed or fluid width variation. - -Use `.container` for a responsive fixed width container. This will center content withing the viewport and apply the appropriate `width` for a given device size. **Containers *can* be nested, but be aware that most layouts don't require it.** - -{% highlight html %} -
- ... -
-{% endhighlight %} - -Use `.container-fluid` for a full width container, spanning the entire width of the viewport. - -{% highlight html %} -
- ... -
-{% endhighlight %} diff --git a/docs/layout/media-queries.md b/docs/layout/media-queries.md deleted file mode 100644 index a72469603b..0000000000 --- a/docs/layout/media-queries.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -layout: page -title: Media queries -group: layout ---- - -Since Bootstrap is responsive and designed to be mobile-first, we employ media queries in our CSS to create responsive pages and components that scale to particular viewports and devices. - -Media queries allow you to group rulesets by a handful of parameters, most notably viewport dimensions, to gracefully scale content across devices. Bootstrap primarily uses the following media query ranges—we call them breakpoints—in our source Sass files for our layout, grid system, and components. - -{% highlight scss %} -/* Extra small devices (portrait phones, less than ???px) */ -/* No media query since this is the default in Bootstrap */ - -/* Small devices (landscape phones, 34em and up) */ -@media (min-width: 34em) { ... } - -/* Medium devices (tablets, 48em and up) */ -@media (min-width: 48em) { ... } - -/* Large devices (desktops, 62em and up) */ -@media (min-width: 62em) { ... } - -/* Extra large devices (large desktops, 75em and up) */ -@media (min-width: 75em) { ... } -{% endhighlight %} - -Since we write our source CSS in Sass, all our media queries are available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-up(xs) { ... } -@include media-breakpoint-up(sm) { ... } -@include media-breakpoint-up(md) { ... } -@include media-breakpoint-up(lg) { ... } -@include media-breakpoint-up(xl) { ... } - -// Example usage: -@include media-breakpoint-up(sm) { - .some-class { - display: block; - } -} -{% endhighlight %} - -We occasionally use media queries that go in the other direction (the given screen size *or smaller*): - -{% highlight scss %} -/* Extra small devices (portrait phones, less than 34em) */ -@media (max-width: 33.9em) { ... } - -/* Small devices (landscape phones, less than 48em) */ -@media (max-width: 47.9em) { ... } - -/* Medium devices (tablets, less than 62em) */ -@media (max-width: 61.9em) { ... } - -/* Large devices (desktops, less than 75em) */ -@media (max-width: 74.9em) { ... } - -/* Extra large devices (large desktops) */ -/* No media query since the extra-large breakpoint has no upper bound on its width */ -{% endhighlight %} - -Once again, these media queries are also available via Sass mixins: - -{% highlight scss %} -@include media-breakpoint-down(xs) { ... } -@include media-breakpoint-down(sm) { ... } -@include media-breakpoint-down(md) { ... } -@include media-breakpoint-down(lg) { ... } -@include media-breakpoint-down(xl) { ... } -{% endhighlight %} diff --git a/docs/layout/overview.md b/docs/layout/overview.md new file mode 100644 index 0000000000..f00f22149e --- /dev/null +++ b/docs/layout/overview.md @@ -0,0 +1,97 @@ +--- +layout: page +title: Overview +group: layout +--- + +Bootstrap includes several components and options for laying out your project, including wrapping containers, a powerful grid system, a flexible media object, and responsive utility classes. + +## Containers + +Containers are the most basic layout element in Bootstrap and are **required when using our grid system**. Choose from a responsive, fixed-width container (meaning it's `max-width` changes at each breakpoint) or fluid-width (meaning it's `100%` wide all the time). + +While containers *can* be nested, most layouts do not require a nested container. + +{% highlight html %} +
+ +
+{% endhighlight %} + +Use `.container-fluid` for a full width container, spanning the entire width of the viewport. + +{% highlight html %} +
+ ... +
+{% endhighlight %} + + +## Responsive breakpoints + +Since Bootstrap is developed to be mobile first, we use a handful of [media queries](https://developer.mozilla.org/en-US/docs/Web/Guide/CSS/Media_queries) to create sensible breakpoints for our layouts and interfaces. These breakpoints are mostly based on minimum viewport widths and allow us to scale up elements as the viewport changes. + +Bootstrap primarily uses the following media query ranges—or breakpoints—in our source Sass files for our layout, grid system, and components. + +{% highlight scss %} +// Extra small devices (portrait phones, less than ???px) +// No media query since this is the default in Bootstrap + +// Small devices (landscape phones, 34em and up) +@media (min-width: 34em) { ... } + +// Medium devices (tablets, 48em and up) +@media (min-width: 48em) { ... } + +// Large devices (desktops, 62em and up) +@media (min-width: 62em) { ... } + +// Extra large devices (large desktops, 75em and up) +@media (min-width: 75em) { ... } +{% endhighlight %} + +Since we write our source CSS in Sass, all our media queries are available via Sass mixins: + +{% highlight scss %} +@include media-breakpoint-up(xs) { ... } +@include media-breakpoint-up(sm) { ... } +@include media-breakpoint-up(md) { ... } +@include media-breakpoint-up(lg) { ... } +@include media-breakpoint-up(xl) { ... } + +// Example usage: +@include media-breakpoint-up(sm) { + .some-class { + display: block; + } +} +{% endhighlight %} + +We occasionally use media queries that go in the other direction (the given screen size *or smaller*): + +{% highlight scss %} +// Extra small devices (portrait phones, less than 34em) +@media (max-width: 33.9em) { ... } + +// Small devices (landscape phones, less than 48em) +@media (max-width: 47.9em) { ... } + +// Medium devices (tablets, less than 62em) +@media (max-width: 61.9em) { ... } + +// Large devices (desktops, less than 75em) +@media (max-width: 74.9em) { ... } + +// Extra large devices (large desktops) +// No media query since the extra-large breakpoint has no upper bound on its width +{% endhighlight %} + +Once again, these media queries are also available via Sass mixins: + +{% highlight scss %} +@include media-breakpoint-down(xs) { ... } +@include media-breakpoint-down(sm) { ... } +@include media-breakpoint-down(md) { ... } +@include media-breakpoint-down(lg) { ... } +@include media-breakpoint-down(xl) { ... } +{% endhighlight %}