diff --git a/_config.yml b/_config.yml index c174f4a7e5..f301a3694b 100644 --- a/_config.yml +++ b/_config.yml @@ -2,6 +2,9 @@ markdown: kramdown highlighter: rouge +kramdown: + auto_ids: true + # Permalinks permalink: pretty diff --git a/docs/_data/nav.yml b/docs/_data/nav.yml new file mode 100644 index 0000000000..48461eb9bb --- /dev/null +++ b/docs/_data/nav.yml @@ -0,0 +1,80 @@ +- title: Getting started + pages: + - title: Quick start + - title: Download + sections: + - title: Precompiled + - title: Source + - title: Bower + - title: npm + - title: Contents + - title: Compiling + - title: Browser and device support + - title: Third aprty support + - title: Accessibility + - title: License FAQs + - title: Translations + +- title: Examples + +- title: Components + pages: + - title: Scaffolding + - title: Grid + sections: + - title: Overview + - title: Typography + sections: + - title: Scale + - title: Body copy + - title: Headings + - title: Images + - title: Code + sections: + - title: Inline code + - title: Preformatted text + - title: Variables + - title: User input + - title: Sample output + - title: Tables + - title: Forms + - title: Buttons + - title: Button groups +# - title: Button dropdowns + - title: Input groups +# - title: Dropdowns + - title: Navigation + - title: Navbar + - title: Breadcrumb + - title: Pagination + - title: Alert + - title: Progress + - title: Media + - title: List + - title: Responsive embed + - title: Helpers + - title: Responsive utilities + sections: + - title: Viewports + - title: Print + - title: Test cases + +- title: JavaScript + pages: + - title: Overview + - title: Transititons + - title: Modal + - title: Dropdown + - title: Scrollspy + - title: Tab + - title: Tooltip + - title: Popover + - title: Alert + - title: Button + - title: Collapse + - title: Carousel + - title: Affix + +- title: Learn & Extend + pages: + - title: Approach diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index 6aff132af8..5edc365f08 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -32,19 +32,19 @@ {% if site.github %} - + {% else %} - + {% endif %} {% if site.github %} - + {% else %} - - - + + + {% endif %} {% if page.slug == "customize" %} - + {% endif %} {% comment %} diff --git a/docs/_includes/getting-started/grunt.html b/docs/_includes/getting-started/grunt.html deleted file mode 100644 index 93fa44a70a..0000000000 --- a/docs/_includes/getting-started/grunt.html +++ /dev/null @@ -1,32 +0,0 @@ -
-

Compiling CSS and JavaScript

- -

Bootstrap uses Grunt for its build system, with convenient methods for working with the framework. It's how we compile our code, run tests, and more.

- -

Installing Grunt

-

To install Grunt, you must first download and install node.js (which includes npm). npm stands for node packaged modules and is a way to manage development dependencies through node.js.

- - Then, from the command line: -
    -
  1. Install grunt-cli globally with npm install -g grunt-cli.
    2. -
  2. Navigate to the root /bootstrap/ directory, then run npm install. npm will look at the package.json file and automatically install the necessary local dependencies listed there.
    3. -
- -

When completed, you'll be able to run the various Grunt commands provided from the command line.

- -

Available Grunt commands

-

grunt dist (Just compile CSS and JavaScript)

-

Regenerates the /dist/ directory with compiled and minified CSS and JavaScript files. As a Bootstrap user, this is normally the command you want.

- -

grunt watch (Watch)

-

Watches the Less source files and automatically recompiles them to CSS whenever you save a change.

- -

grunt test (Run tests)

-

Runs JSHint and runs the QUnit tests headlessly in PhantomJS.

- -

grunt (Build absolutely everything and run tests)

-

Compiles and minifies CSS and JavaScript, builds the documentation website, runs the HTML5 validator against the docs, regenerates the Customizer assets, and more. Usually only necessary if you're hacking on Bootstrap itself.

- -

Troubleshooting

-

Should you encounter problems with installing dependencies or running Grunt commands, first delete the /node_modules/ directory generated by npm. Then, rerun npm install.

-
diff --git a/docs/_includes/getting-started/whats-included.html b/docs/_includes/getting-started/whats-included.html deleted file mode 100644 index cf1fec0c32..0000000000 --- a/docs/_includes/getting-started/whats-included.html +++ /dev/null @@ -1,42 +0,0 @@ -
-

What's included

- -

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.

- -
-

jQuery required

-

Please note that all JavaScript plugins require jQuery to be included, as shown in the starter template. Consult our bower.json to see which versions of jQuery are supported.

-
- -

Precompiled Bootstrap

-

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 -│ ├── 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 (bootstrap.min.*). 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.

-
diff --git a/docs/_includes/header.html b/docs/_includes/header.html index 47e7e9839f..8514235a94 100644 --- a/docs/_includes/header.html +++ b/docs/_includes/header.html @@ -15,29 +15,29 @@ {% if site.github %} - + {% else %} - + {% endif %} {% if page.slug == "css" or page.slug == "components" or page.slug == "js" %} {% if site.github %} - + {% else %} - + {% endif %} {% endif %} - + - - + + - - + +