From 68f61c8eb146c9e3e886bf91e3fd27b5d4b192d4 Mon Sep 17 00:00:00 2001 From: Kevin Ross Date: Wed, 9 Mar 2016 10:23:01 -0600 Subject: [PATCH] bsDocs components --- Gruntfile.js | 66 +++++++++++++++--------------- docs/components/alerts.md | 7 ++-- docs/components/breadcrumb.md | 7 ++-- docs/components/button-dropdown.md | 7 ++-- docs/components/button-group.md | 7 ++-- docs/components/buttons.md | 7 ++-- docs/components/card.md | 7 ++-- docs/components/carousel.md | 7 ++-- docs/components/collapse.md | 7 ++-- docs/components/dropdowns.md | 7 ++-- docs/components/forms.md | 7 ++-- docs/components/input-group.md | 7 ++-- docs/components/jumbotron.md | 7 ++-- docs/components/list-group.md | 7 ++-- docs/components/modal.md | 7 ++-- docs/components/navbar.md | 7 ++-- docs/components/navs.md | 7 ++-- docs/components/pagination.md | 7 ++-- docs/components/popovers.md | 7 ++-- docs/components/progress.md | 7 ++-- docs/components/scrollspy.md | 7 ++-- docs/components/tag.md | 7 ++-- docs/components/tooltips.md | 7 ++-- docs/components/utilities.md | 7 ++-- gulpfile.babel.js | 36 +++++++++++++--- 25 files changed, 155 insertions(+), 108 deletions(-) diff --git a/Gruntfile.js b/Gruntfile.js index 6702695b..26dba52a 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -303,38 +303,38 @@ module.exports = function (grunt) { ], dest: 'docs/assets/scss/' }, - 'bs-docs-components': { - options: { - // //https://regex101.com/r/cZ7aO8/2 - process: function (content, srcpath) { - return content.replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice); - } - }, - expand: true, - cwd: '../bootstrap/docs/components', - src: [ - '**/*' - ], - dest: 'docs/components/' - }, - 'bs-docs-getting-started': { - options: { - // https://regex101.com/r/cZ7aO8/2 - process: function (content, srcpath) { - return content - // insert docs reference - .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) - // remove sample text 'display' as this is a particular style and is confusing - .replace(/Fancy display heading/, 'Fancy heading'); - } - }, - expand: true, - cwd: '../bootstrap/docs/getting-started', - src: [ - 'browsers-devices.md' // only one file - ], - dest: 'docs/getting-started/' - }, + //'bs-docs-components': { + // options: { + // // //https://regex101.com/r/cZ7aO8/2 + // process: function (content, srcpath) { + // return content.replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice); + // } + // }, + // expand: true, + // cwd: '../bootstrap/docs/components', + // src: [ + // '**/*' + // ], + // dest: 'docs/components/' + //}, + //'bs-docs-getting-started': { + // options: { + // // https://regex101.com/r/cZ7aO8/2 + // process: function (content, srcpath) { + // return content + // // insert docs reference + // .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) + // // remove sample text 'display' as this is a particular style and is confusing + // .replace(/Fancy display heading/, 'Fancy heading'); + // } + // }, + // expand: true, + // cwd: '../bootstrap/docs/getting-started', + // src: [ + // 'browsers-devices.md' // only one file + // ], + // dest: 'docs/getting-started/' + //}, //'bs-docs-content': { // options: { // // https://regex101.com/r/cZ7aO8/2 @@ -592,7 +592,7 @@ module.exports = function (grunt) { grunt.registerTask('docs-copy-bootstrap-docs', [ 'copy:bs-docs-js-vendor', 'copy:bs-docs-scss', - 'copy:bs-docs-getting-started', + //'copy:bs-docs-getting-started', 'copy:bs-docs-components', 'copy:bs-docs-content', 'copy:bs-docs-plugins' diff --git a/docs/components/alerts.md b/docs/components/alerts.md index 559b93ae..723cf9f5 100644 --- a/docs/components/alerts.md +++ b/docs/components/alerts.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Provide contextual feedback messages for typical user actions with the handful of available and flexible alert messages. ## Contents diff --git a/docs/components/breadcrumb.md b/docs/components/breadcrumb.md index b3759c0d..b82a571e 100644 --- a/docs/components/breadcrumb.md +++ b/docs/components/breadcrumb.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Indicate the current page's location within a navigational hierarchy. Separators are automatically added in CSS through [`::before`](https://developer.mozilla.org/en-US/docs/Web/CSS/::before) and [`content`](https://developer.mozilla.org/en-US/docs/Web/CSS/content). {% example html %} diff --git a/docs/components/button-dropdown.md b/docs/components/button-dropdown.md index 1139d260..8f96a72d 100644 --- a/docs/components/button-dropdown.md +++ b/docs/components/button-dropdown.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Use any button to trigger a dropdown menu by placing it within a `.btn-group` and providing the proper dropdown menu markup. {% callout danger %} diff --git a/docs/components/button-group.md b/docs/components/button-group.md index 42991787..8955d760 100644 --- a/docs/components/button-group.md +++ b/docs/components/button-group.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Group a series of buttons together on a single line with the button group. Add on optional JavaScript radio and checkbox style behavior with [our buttons plugin]({{ site.baseurl }}/components/buttons/#button-plugin). ## Contents diff --git a/docs/components/buttons.md b/docs/components/buttons.md index 37dfd54a..a728886a 100644 --- a/docs/components/buttons.md +++ b/docs/components/buttons.md @@ -8,14 +8,15 @@ redirect_from: "/components/" [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Use Bootstrap's custom button styles for actions in forms, dialogs, and more. Includes support for a handful of contextual variations, sizes, states, and more. ## Contents diff --git a/docs/components/card.md b/docs/components/card.md index 0a316516..66d19e65 100644 --- a/docs/components/card.md +++ b/docs/components/card.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + A **card** is a flexible and extensible content container. It includes options for headers and footers, a wide variety of content, contextual background colors, and powerful display options. If you're familiar with Bootstrap 3, cards replace our old panels, wells, and thumbnails. Similar functionality to those components is available as modifier classes for cards. diff --git a/docs/components/carousel.md b/docs/components/carousel.md index ceeb4461..51af0fe5 100644 --- a/docs/components/carousel.md +++ b/docs/components/carousel.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + A slideshow component for cycling through elements—images or slides of text—like a carousel. In browsers where the [Page Visibility API](http://www.w3.org/TR/page-visibility/) is supported, the carousel will avoid sliding when the webpage is not visible to the user (such as when the browser tab is inactive, the browser window is minimized, etc.). **Nested carousels are not supported.** ## Contents diff --git a/docs/components/collapse.md b/docs/components/collapse.md index 72117570..d094cf58 100644 --- a/docs/components/collapse.md +++ b/docs/components/collapse.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + The Bootstrap collapse plugin allows you to toggle content on your pages with a bit of JavaScript and some classes. Flexible plugin that utilizes a handful of classes (from the **required [transitions plugin]({{ site.baseurl }}/components/transitions/)**) for easy toggle behavior. ## Contents diff --git a/docs/components/dropdowns.md b/docs/components/dropdowns.md index 78134dc6..25880afe 100644 --- a/docs/components/dropdowns.md +++ b/docs/components/dropdowns.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Dropdowns are toggleable, contextual overlays for displaying lists of links and more. They're made interactive with the included Bootstrap dropdown JavaScript plugin. They're toggled by clicking, not by hovering; this is [an intentional design decision.](http://markdotto.com/2012/02/27/bootstrap-explained-dropdowns/) ## Contents diff --git a/docs/components/forms.md b/docs/components/forms.md index ba612461..430c15e9 100644 --- a/docs/components/forms.md +++ b/docs/components/forms.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Bootstrap provides several form control styles, layout options, and custom components for creating a wide variety of forms. ## Contents diff --git a/docs/components/input-group.md b/docs/components/input-group.md index 98764050..58788294 100644 --- a/docs/components/input-group.md +++ b/docs/components/input-group.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Easily extend form controls by adding text, buttons, or button groups on either side of textual ``s. ## Contents diff --git a/docs/components/jumbotron.md b/docs/components/jumbotron.md index f1f1d34a..b6649ad4 100644 --- a/docs/components/jumbotron.md +++ b/docs/components/jumbotron.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + A lightweight, flexible component that can optionally extend the entire viewport to showcase key marketing messages on your site. ## Example diff --git a/docs/components/list-group.md b/docs/components/list-group.md index c627c707..1e74905d 100644 --- a/docs/components/list-group.md +++ b/docs/components/list-group.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + List groups are a flexible and powerful component for displaying not only simple lists of elements, but complex ones with custom content. ## Contents diff --git a/docs/components/modal.md b/docs/components/modal.md index e5bf5c5c..2c43c5b1 100644 --- a/docs/components/modal.md +++ b/docs/components/modal.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Modals are streamlined, but flexible, dialog prompts with the minimum required functionality and smart defaults. ## Contents diff --git a/docs/components/navbar.md b/docs/components/navbar.md index 60debe4b..bca78508 100644 --- a/docs/components/navbar.md +++ b/docs/components/navbar.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + The navbar is a simple wrapper for positioning branding, navigation, and other elements into a concise navigation header. It's easily extensible and, with the help of our collapse plugin, it can easily integrate offscreen content. ## Contents diff --git a/docs/components/navs.md b/docs/components/navs.md index 2ffd55af..85730d46 100644 --- a/docs/components/navs.md +++ b/docs/components/navs.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Navigation available in Bootstrap share general markup and styles, from the base `.nav` class to the active and disabled states. Swap modifier classes to switch between each style. ## Contents diff --git a/docs/components/pagination.md b/docs/components/pagination.md index e94751bb..6e9f86b1 100644 --- a/docs/components/pagination.md +++ b/docs/components/pagination.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Provide pagination links for your site or app with the multi-page pagination component. ## Contents diff --git a/docs/components/popovers.md b/docs/components/popovers.md index e0259cbe..c996f97e 100644 --- a/docs/components/popovers.md +++ b/docs/components/popovers.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Add small overlay content, like those found in iOS, to any element for housing secondary information. ## Contents diff --git a/docs/components/progress.md b/docs/components/progress.md index 8056f473..0b7dc1a5 100644 --- a/docs/components/progress.md +++ b/docs/components/progress.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Stylize [the HTML5 `` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/progress) with a few extra classes and some crafty browser-specific CSS. Be sure to read up on the browser support. ## Contents diff --git a/docs/components/scrollspy.md b/docs/components/scrollspy.md index f1d61adf..4e0b173b 100644 --- a/docs/components/scrollspy.md +++ b/docs/components/scrollspy.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + ## Contents * Will be replaced with the ToC, excluding the "Contents" header diff --git a/docs/components/tag.md b/docs/components/tag.md index f70b3189..1e2c9242 100644 --- a/docs/components/tag.md +++ b/docs/components/tag.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Small and adaptive tag for adding context to just about any content. ## Example diff --git a/docs/components/tooltips.md b/docs/components/tooltips.md index ea3ce0b9..2eb87a30 100644 --- a/docs/components/tooltips.md +++ b/docs/components/tooltips.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Inspired by the excellent Tipsy jQuery plugin written by Jason Frame. Tooltips are an updated version, which don't rely on images, use CSS3 for animations, and data-attributes for local title storage. ## Contents diff --git a/docs/components/utilities.md b/docs/components/utilities.md index 81894548..56df3937 100644 --- a/docs/components/utilities.md +++ b/docs/components/utilities.md @@ -7,14 +7,15 @@ group: components [//]: # DO NOT EDIT IT WILL BE OVERWRITTEN - copy of bootstrap documentation generated by grunt docs-copy-bootstrap-docs {% callout info %} -**Bootstrap Reference Documentation** -This is a part of the reference documentation from Bootstrap. -It is included here to demonstrate rendering with Material Design for Bootstrap default styling. +**Bootstrap Reference Documentation** +This is a part of the reference documentation from Bootstrap. +It is included here to demonstrate rendering with Material Design for Bootstrap default styling. See the Material Design section for more elements and customization options. {% endcallout %} + Bootstrap includes dozens of utilities—classes with a single purpose. They're designed to reduce the frequency of highly repetitive declarations in your CSS while allowing for quick and easy development. ## Contents diff --git a/gulpfile.babel.js b/gulpfile.babel.js index 024632d0..927ceda4 100644 --- a/gulpfile.babel.js +++ b/gulpfile.babel.js @@ -154,6 +154,12 @@ let docs = [ ] +const docsProcess = (content, srcpath) => { // https://regex101.com/r/cZ7aO8/2 + return content + .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) // insert docs reference + .replace(/Fancy display heading/, 'Fancy heading') // remove sample text 'display' as this is a particular MD style and is confusing +} + let bsDocs = [ new Copy(gulp, docsPreset, docsConfig, { task: {name: 'copy:bs-docs-content'}, @@ -162,10 +168,28 @@ let bsDocs = [ glob: ['**/*'] }, dest: 'docs/content/', - process: (content, srcpath) => { // https://regex101.com/r/cZ7aO8/2 - return content - .replace(/(---[\s\S]+?---)([\s\S]+)/mg, referenceDocNotice) // insert docs reference - .replace(/Fancy display heading/, 'Fancy heading') // remove sample text 'display' as this is a particular MD style and is confusing - } - }) + process: docsProcess + }), + + //new Copy(gulp, docsPreset, docsConfig, { + // task: {name: 'copy:bs-docs-getting-started'}, + // source: { + // options: {cwd: '../bootstrap/docs/getting-started'}, + // glob: ['**/*'] + // }, + // dest: 'docs/getting-started/', + // process: docsProcess + //}), + + new Copy(gulp, docsPreset, docsConfig, { + task: {name: 'copy:bs-docs-components'}, + source: { + options: {cwd: '../bootstrap/docs/components'}, + glob: ['**/*'] + }, + dest: 'docs/components/', + process: docsProcess + }), ] + +new TaskSeries(gulp, 'bsDocs', bsDocs)