aboutsummaryrefslogtreecommitdiff
path: root/docs/getting-started/contents.md
diff options
context:
space:
mode:
authorMark Otto <[email protected]>2014-07-10 17:54:06 -0700
committerMark Otto <[email protected]>2014-07-10 17:54:06 -0700
commit4993ab6e0038f73aed82ecfdcb58d51b8d6be917 (patch)
tree3d186262cc895f9a6aaf1f1df4a45c3a2104a499 /docs/getting-started/contents.md
parent57c709becd2bb2ed93f9004c04d48c4a65836cb8 (diff)
downloadbootstrap-4993ab6e0038f73aed82ecfdcb58d51b8d6be917.tar.xz
bootstrap-4993ab6e0038f73aed82ecfdcb58d51b8d6be917.zip
start markdowning getting started and moving things to separate pages
Diffstat (limited to 'docs/getting-started/contents.md')
-rw-r--r--docs/getting-started/contents.md48
1 files changed, 48 insertions, 0 deletions
diff --git a/docs/getting-started/contents.md b/docs/getting-started/contents.md
new file mode 100644
index 000000000..b5fec9e82
--- /dev/null
+++ b/docs/getting-started/contents.md
@@ -0,0 +1,48 @@
+---
+layout: page
+title: Contents
+---
+
+Bootstrap is downloadable in two forms, within which you'll find the following directories and files, logically grouping common resources and providing both compiled and minified variations.
+
+<div class="bs-callout bs-callout-warning" id="jquery-required">
+ <h4>jQuery required</h4>
+ <p>Please note that <strong>all JavaScript plugins require jQuery</strong> to be included, as shown in the <a href="#template">starter template</a>. <a href="{{ site.repo }}/blob/v{{ site.current_version }}/bower.json">Consult our <code>bower.json</code></a> to see which versions of jQuery are supported.</p>
+</div>
+
+### Precompiled Bootstrap
+
+Once downloaded, unzip the compressed folder to see the structure of (the compiled) Bootstrap. You'll see something like this:
+
+<!-- NOTE: This info is intentionally duplicated in the README. Copy any changes made here over to the README too. -->
+
+{% highlight bash %}
+bootstrap/
+├── css/
+│ ├── bootstrap.css
+│ ├── bootstrap.min.css
+│ ├── bootstrap-theme.css
+│ └── bootstrap-theme.min.css
+└── js/
+ ├── bootstrap.js
+ └── bootstrap.min.js
+{% endhighlight %}
+
+This is the most basic form of Bootstrap: precompiled 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 (1bootstrap.min.*1). Also included is the optional Bootstrap theme.
+
+### Bootstrap source code
+
+The Bootstrap source code download includes the precompiled CSS and JavaScript assets, along with source Less, JavaScript, and documentation. More specifically, it includes the following and more:
+
+{% highlight bash %}
+bootstrap/
+├── less/
+├── js/
+├── dist/
+│ ├── css/
+│ └── js/
+└── docs/
+ └── examples/
+{% endhighlight %}
+
+The `less/` and `js/` are the source code for our CSS and JavaScript. The `dist/` folder includes everything listed in the precompiled download section above. The `docs/` folder includes the source code for our documentation, and `examples/` of Bootstrap usage. Beyond that, any other included file provides support for packages, license information, and development.