Merge pull request #12037 from twbs/docs_dir

Bring back the `/docs` directory

Gruntfile.js

@@ -44,7 +44,7 @@ module.exports = function (grunt) {
         src: ['js/tests/unit/*.js']
       },
       assets: {
-        src: ['docs-assets/js/application.js', 'docs-assets/js/customizer.js']
+        src: ['docs/assets/js/application.js', 'docs/assets/js/customizer.js']
       }
     },
 
@@ -65,12 +65,12 @@ module.exports = function (grunt) {
 
     csslint: {
       options: {
-        csslintrc: '.csslintrc'
+        csslintrc: 'less/.csslintrc'
       },
       src: [
         'dist/css/bootstrap.css',
         'dist/css/bootstrap-theme.css',
-        'docs-assets/css/docs.css'
+        'docs/assets/css/docs.css'
       ]
     },
 
@@ -118,13 +118,13 @@ module.exports = function (grunt) {
           report: 'min'
         },
         src: [
-          'docs-assets/js/less.js',
-          'docs-assets/js/jszip.js',
-          'docs-assets/js/uglify.js',
-          'docs-assets/js/filesaver.js',
-          'docs-assets/js/customizer.js'
+          'docs/assets/js/less.js',
+          'docs/assets/js/jszip.js',
+          'docs/assets/js/uglify.js',
+          'docs/assets/js/filesaver.js',
+          'docs/assets/js/customizer.js'
         ],
-        dest: 'docs-assets/js/customize.js'
+        dest: 'docs/assets/js/customize.js'
       }
     },
 
@@ -185,7 +185,7 @@ module.exports = function (grunt) {
     csscomb: {
       sort: {
         options: {
-          sortOrder: '.csscomb.json'
+          config: 'less/.csscomb.json'
         },
         files: {
           'dist/css/<%= pkg.name %>.css': ['dist/css/<%= pkg.name %>.css'],
@@ -199,6 +199,16 @@ module.exports = function (grunt) {
         expand: true,
         src: ['fonts/*'],
         dest: 'dist/'
+      },
+      docs: {
+        expand: true,
+        cwd: './dist',
+        src: [
+          '{css,js}/*.min.*',
+          '{css}/*.map',
+          'fonts/*'
+        ],
+        dest: 'docs/dist'
       }
     },
 
@@ -309,10 +319,10 @@ module.exports = function (grunt) {
   grunt.registerTask('dist-css', ['less', 'csscomb', 'usebanner']);
 
   // Fonts distribution task.
-  grunt.registerTask('dist-fonts', ['copy']);
+  grunt.registerTask('dist-docs', ['copy:docs']);
 
   // Full distribution task.
-  grunt.registerTask('dist', ['clean', 'dist-css', 'dist-fonts', 'dist-js']);
+  grunt.registerTask('dist', ['clean', 'dist-css', 'copy:fonts', 'dist-js']);
 
   // Default task.
   grunt.registerTask('default', ['test', 'dist', 'build-glyphicons-data', 'build-customizer']);
@@ -341,9 +351,9 @@ module.exports = function (grunt) {
     }
 
     // Create the `_data` directory if it doesn't already exist
-    if (!fs.existsSync('_data')) fs.mkdirSync('_data')
+    if (!fs.existsSync('docs/_data')) fs.mkdirSync('docs/_data')
 
-    fs.writeFileSync('_data/glyphicons.yml', glyphiconsData)
+    fs.writeFileSync('docs/_data/glyphicons.yml', glyphiconsData)
   });
 
   // task for building customizer
@@ -362,6 +372,6 @@ module.exports = function (grunt) {
     }
 
     var files = getFiles('js') + getFiles('less') + getFiles('fonts')
-    fs.writeFileSync('docs-assets/js/raw-files.js', files)
+    fs.writeFileSync('docs/assets/js/raw-files.js', files)
   });
 };

_config.yml

@@ -6,36 +6,26 @@ pygments:         true
 permalink:        pretty
 
 # Server
+source:           ./docs
 destination:      ./_gh_pages
+host:             0.0.0.0
 port:             9001
-exclude:
-- ".editorconfig"
-- ".gitignore"
-- "bower.json"
-- "CNAME"
-- "composer.json"
-- "CONTRIBUTING.md"
-- "DOCS-LICENSE"
-- "Gruntfile.js"
-- "less"
-- "LICENSE"
-- "node_modules"
-- "package.json"
-- "README.md"
-- "sauce_browsers.yml"
-- "test-infra"
+baseurl:          /
+url:              http://localhost:9001
 
 # Custom vars
 current_version:  3.0.3
 repo:             https://github.com/twbs/bootstrap
 
-download_source:  https://github.com/twbs/bootstrap/archive/v3.0.3.zip
-download_dist:    https://github.com/twbs/bootstrap/releases/download/v3.0.3/bootstrap-3.0.3-dist.zip
+download:
+  source:         https://github.com/twbs/bootstrap/archive/v3.0.3.zip
+  dist:           https://github.com/twbs/bootstrap/releases/download/v3.0.3/bootstrap-3.0.3-dist.zip
 
 blog:             http://blog.getbootstrap.com
 expo:             http://expo.getbootstrap.com
 sass_repo:        https://github.com/twbs/bootstrap-sass
 
-cdn_css:          //netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap.min.css
-cdn_theme_css:    //netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap-theme.min.css
-cdn_js:           //netdna.bootstrapcdn.com/bootstrap/3.0.3/js/bootstrap.min.js
+cdn:
+  css:            //netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap.min.css
+  css_theme:      //netdna.bootstrapcdn.com/bootstrap/3.0.3/css/bootstrap-theme.min.css
+  js:             //netdna.bootstrapcdn.com/bootstrap/3.0.3/js/bootstrap.min.js

_includes/footer.html → docs/_includes/footer.html

@@ -2,15 +2,15 @@
 ================================================== -->
 <!-- Placed at the end of the document so the pages load faster -->
 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
-<script src="{{ page.base_url }}dist/js/bootstrap.min.js"></script>
+<script src="dist/js/bootstrap.min.js"></script>
 
-<script src="{{ page.base_url }}docs-assets/js/holder.js"></script>
+<script src="assets/js/holder.js"></script>
 
-<script src="{{ page.base_url }}docs-assets/js/application.js"></script>
+<script src="assets/js/application.js"></script>
 
 {% if page.slug == "customize" %}
-<script src="{{ page.base_url }}docs-assets/js/raw-files.js"></script>
-<script src="{{ page.base_url }}docs-assets/js/customize.js"></script>
+<script src="assets/js/raw-files.js"></script>
+<script src="assets/js/customize.js"></script>
 {% endif %}
 
 {% comment %}

_includes/header.html → docs/_includes/header.html

@@ -14,12 +14,12 @@
 </title>
 
 <!-- Bootstrap core CSS -->
-<link href="{{ page.base_url }}dist/css/bootstrap.min.css" rel="stylesheet">
+<link href="{{ site.baseurl }}dist/css/bootstrap.min.css" rel="stylesheet">
 
 <!-- Documentation extras -->
-<link href="{{ page.base_url }}docs-assets/css/docs.css" rel="stylesheet">
-<link href="{{ page.base_url }}docs-assets/css/pygments-manni.css" rel="stylesheet">
-<!--[if lt IE 9]><script src="{{ page.base_url }}docs-assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
+<link href="{{ site.baseurl }}assets/css/docs.css" rel="stylesheet">
+<link href="{{ site.baseurl }}assets/css/pygments-manni.css" rel="stylesheet">
+<!--[if lt IE 9]><script src="{{ site.baseurl }}assets/js/ie8-responsive-file-warning.js"></script><![endif]-->
 
 <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
 <!--[if lt IE 9]>
@@ -28,8 +28,8 @@
 <![endif]-->
 
 <!-- Favicons -->
-<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ page.base_url }}docs-assets/ico/apple-touch-icon-144-precomposed.png">
-                               <link rel="shortcut icon" href="{{ page.base_url }}docs-assets/ico/favicon.ico">
+<link rel="apple-touch-icon-precomposed" sizes="144x144" href="{{ site.baseurl }}assets/ico/apple-touch-icon-144-precomposed.png">
+                               <link rel="shortcut icon" href="{{ site.baseurl }}assets/ico/favicon.ico">
 
 <script>
   var _gaq = _gaq || [];

_includes/nav-main.html → docs/_includes/nav-main.html

@@ -7,29 +7,29 @@
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
-      <a href="{{ page.base_url }}" class="navbar-brand">Bootstrap</a>
+      <a href="{{ site.baseurl }}" class="navbar-brand">Bootstrap</a>
     </div>
     <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation">
       <ul class="nav navbar-nav">
         <li{% if page.slug == "getting-started" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}getting-started">Getting started</a>
+          <a href="{{ site.baseurl }}getting-started">Getting started</a>
         </li>
         <li{% if page.slug == "css" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}css">CSS</a>
+          <a href="{{ site.baseurl }}css">CSS</a>
         </li>
         <li{% if page.slug == "components" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}components">Components</a>
+          <a href="{{ site.baseurl }}components">Components</a>
         </li>
         <li{% if page.slug == "js" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}javascript">JavaScript</a>
+          <a href="{{ site.baseurl }}javascript">JavaScript</a>
         </li>
         <li{% if page.slug == "customize" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}customize">Customize</a>
+          <a href="{{ site.baseurl }}customize">Customize</a>
         </li>
       </ul>
       <ul class="nav navbar-nav navbar-right">
         <li{% if page.slug == "about" %} class="active"{% endif %}>
-          <a href="{{ page.base_url }}about">About</a>
+          <a href="{{ site.baseurl }}about">About</a>
         </li>
       </ul>
     </nav>

_includes/old-bs-docs.html → docs/_includes/old-bs-docs.html

 <div class="bs-old-docs">
   <div class="container">
     <strong>
-      <a href="{{ page.base_url }}2.3.2/">Looking for Bootstrap 2.3.2 docs?</a>
+      <a href="{{ site.baseurl }}2.3.2/">Looking for Bootstrap 2.3.2 docs?</a>
     </strong>
     We've moved it to a new home while we push forward with Bootstrap 3. <a href="http://blog.getbootstrap.com/">Read the blog</a> for details.
   </div>

_layouts/default.html → docs/_layouts/default.html

@@ -63,7 +63,7 @@
         <ul class="footer-links">
           <li>Currently v{{ site.current_version }}</li>
           <li class="muted">&middot;</li>
-          <li><a href="{{ page.base_url }}2.3.2/">Bootstrap 2.3.2 docs</a></li>
+          <li><a href="{{ site.baseurl }}2.3.2/">Bootstrap 2.3.2 docs</a></li>
           <li class="muted">&middot;</li>
           <li><a href="{{ site.blog }}">Blog</a></li>
           <li class="muted">&middot;</li>

_layouts/home.html → docs/_layouts/home.html

@@ -23,13 +23,13 @@
           Currently v{{ site.current_version }}
         </li>
         <li>
-          <a href="{{ page.base_url }}2.3.2/">Bootstrap 2.3.2 docs</a>
+          <a href="{{ site.baseurl }}2.3.2/">Bootstrap 2.3.2 docs</a>
         </li>
         <li>
           <a href="{{ site.repo }}" onclick="_gaq.push(['_trackEvent', 'Jumbotron actions', 'Jumbotron links', 'GitHub project']);">GitHub project</a>
         </li>
         <li>
-          <a href="{{ page.base_url }}getting-started/#examples" onclick="_gaq.push(['_trackEvent', 'Jumbotron actions', 'Jumbotron links', 'Examples']);">Examples</a>
+          <a href="{{ site.baseurl }}getting-started/#examples" onclick="_gaq.push(['_trackEvent', 'Jumbotron actions', 'Jumbotron links', 'Examples']);">Examples</a>
         </li>
         <li>
           <a href="{{ site.expo }}" onclick="_gaq.push(['_trackEvent', 'Jumbotron actions', 'Jumbotron links', 'Expo']);">Expo</a>

about.html → docs/about.html

@@ -3,7 +3,6 @@ layout: default
 title: About
 slug: about
 lead: "Learn about the history of Bootstrap, meet the core team, and check out the ever-growing community resources."
-base_url: "../"
 ---
 
 

components.html → docs/components.html

@@ -3,7 +3,6 @@ layout: default
 title: Components
 slug: components
 lead: "Over a dozen reusable components built to provide iconography, dropdowns, navigation, alerts, popovers, and much more."
-base_url: "../"
 ---
 
 
@@ -1422,7 +1421,7 @@ base_url: "../"
 
     <div class="bs-callout bs-callout-warning">
       <h4>Mobile device caveats</h4>
-      <p>There are some caveats regarding using form controls within fixed elements on mobile devices. <a href="{{ page.base_url }}getting-started#support-fixed-position-keyboards">See our browser support docs</a> for details.</p>
+      <p>There are some caveats regarding using form controls within fixed elements on mobile devices. <a href="{{ site.baseurl }}getting-started#support-fixed-position-keyboards">See our browser support docs</a> for details.</p>
     </div>
 
     <div class="bs-callout bs-callout-danger">
@@ -1455,7 +1454,7 @@ base_url: "../"
 
     <div class="bs-callout bs-callout-warning">
       <h4>Context-specific usage</h4>
-      <p>Like the standard <a href="{{ page.base_url }}css#buttons">button classes</a>, <code>.navbar-btn</code> can be used on <code>&lt;a&gt;</code> and <code>&lt;input&gt;</code> elements. However, neither <code>.navbar-btn</code> nor the standard button classes should be used on <code>&lt;a&gt;</code> elements within <code>.navbar-nav</code>.</p>
+      <p>Like the standard <a href="{{ site.baseurl }}css#buttons">button classes</a>, <code>.navbar-btn</code> can be used on <code>&lt;a&gt;</code> and <code>&lt;input&gt;</code> elements. However, neither <code>.navbar-btn</code> nor the standard button classes should be used on <code>&lt;a&gt;</code> elements within <code>.navbar-nav</code>.</p>
     </div>
 
     <h2 id="navbar-text">Text</h2>

css.html → docs/css.html

@@ -3,7 +3,6 @@ layout: default
 title: CSS
 slug: css
 lead: "Global CSS settings, fundamental HTML elements styled and enhanced with extensible classes, and an advanced grid system."
-base_url: "../"
 ---
 
 
@@ -2553,7 +2552,7 @@ For example, <code>&lt;section&gt;</code> should be wrapped as inline.
 
 
     <h3 id="helper-classes-screen-readers">Screen reader content</h3>
-    <p>Hide an element to all devices <strong>except screen readers</strong> with <code>.sr-only</code>. Necessary for following <a href="{{ page.base_url }}getting-started#accessibility">accessibility best practices</a>. Can also be used as a mixin.</p>
+    <p>Hide an element to all devices <strong>except screen readers</strong> with <code>.sr-only</code>. Necessary for following <a href="{{ site.baseurl }}getting-started#accessibility">accessibility best practices</a>. Can also be used as a mixin.</p>
 {% highlight html %}
 <a class="sr-only" href="#content">Skip to main content</a>
 {% endhighlight %}
@@ -2821,11 +2820,11 @@ For example, <code>&lt;section&gt;</code> should be wrapped as inline.
     </div>
     <p class="lead">Bootstrap's CSS is built on Less, a preprocessor with additional functionality like variables, mixins, and functions for compiling CSS. Those looking to use the source Less files instead of our compiled CSS files can make use of the numerous variables and mixins we use throughout the framework.</p>
 
-    <p>Grid variables and mixins are covered <a href="{{ page.base_url }}css/#grid-less">within the Grid system section</a>.</p>
+    <p>Grid variables and mixins are covered <a href="{{ site.baseurl }}css/#grid-less">within the Grid system section</a>.</p>
 
 
     <h2 id="less-variables">Variables</h2>
-    <p>Variables are used throughout the entire project as a way to centralize and share commonly used values like colors, spacing, or font stacks. For a complete breakdown, please see <a href="{{ page.base_url }}customize/#less-variables-section">the Customizer</a>.</p>
+    <p>Variables are used throughout the entire project as a way to centralize and share commonly used values like colors, spacing, or font stacks. For a complete breakdown, please see <a href="{{ site.baseurl }}customize/#less-variables-section">the Customizer</a>.</p>
 
     <h3 id="less-variables-colors">Colors</h3>
     <p>Easily make use of two color schemes: grayscale and semantic. Grayscale colors provide quick access to commonly used shades of black while semantic include various colors assigned to meaningful contextual values.</p>

customize.html → docs/customize.html

@@ -3,7 +3,6 @@ layout: default
 title: Customize and download
 slug: customize
 lead: Customize Bootstrap's components, LESS variables, and jQuery plugins to get your very own version.
-base_url: "../"
 ---
 
 <!-- Customizer form -->