diff --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 100% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md diff --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 100% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md diff --git a/.hound.yml b/.hound.yml index 3387b0ce0a..7449ea3f95 100644 --- a/.hound.yml +++ b/.hound.yml @@ -1,7 +1,7 @@ fail_on_violations: true scss: - config_file: scss/.scss-lint.yml + config_file: .scss-lint.yml jshint: enabled: false diff --git a/scss/.scss-lint.yml b/.scss-lint.yml similarity index 99% rename from scss/.scss-lint.yml rename to .scss-lint.yml index 845001ef42..a5b5b1ba03 100644 --- a/scss/.scss-lint.yml +++ b/.scss-lint.yml @@ -1,6 +1,6 @@ # Default application configuration that all configurations inherit from. scss_files: - - "**/*.scss" + - "scss/**/*.scss" - "docs/assets/scss/**/*.scss" plugin_directories: ['.scss-linters'] @@ -38,7 +38,7 @@ linters: Comment: enabled: true exclude: - - bootstrap.scss + - scss/bootstrap.scss style: silent DebugStatement: diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 7b60d7c9a6..0000000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,5 +0,0 @@ -Bootstrap uses [GitHub's Releases feature](https://github.com/blog/1547-release-your-software) for its changelogs. - -See [the Releases section of our GitHub project](https://github.com/twbs/bootstrap/releases) for changelogs for each release version of Bootstrap. - -Release announcement posts on [the official Bootstrap blog](https://blog.getbootstrap.com) contain summaries of the most noteworthy changes made in each release. diff --git a/Gemfile b/Gemfile index 1a8977f8db..2fa340d111 100644 --- a/Gemfile +++ b/Gemfile @@ -4,5 +4,6 @@ group :development, :test do gem 'jekyll', '~> 3.4.3' gem 'jekyll-redirect-from', '~> 0.12.1' gem 'jekyll-sitemap', '~> 1.1.1' + gem 'jekyll-toc', '~> 0.3.0.pre1' gem 'scss_lint', '~> 0.53.0' end diff --git a/Gemfile.lock b/Gemfile.lock index 4df2612fcd..5b894b564f 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -5,6 +5,7 @@ GEM public_suffix (~> 2.0, >= 2.0.2) colorator (1.1.0) ffi (1.9.18) + ffi (1.9.18-x64-mingw32) forwardable-extended (2.6.0) jekyll (3.4.3) addressable (~> 2.4) @@ -23,6 +24,8 @@ GEM sass (~> 3.4) jekyll-sitemap (1.1.1) jekyll (~> 3.3) + jekyll-toc (0.3.0.pre1) + nokogiri (~> 1.6) jekyll-watch (1.5.0) listen (~> 3.0, < 3.1) kramdown (1.13.2) @@ -31,6 +34,9 @@ GEM rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) mercenary (0.3.6) + mini_portile2 (2.1.0) + nokogiri (1.7.2) + mini_portile2 (~> 2.1.0) pathutil (0.14.0) forwardable-extended (~> 2.6) public_suffix (2.0.5) @@ -40,19 +46,21 @@ GEM ffi (>= 0.5.0) rouge (1.11.1) safe_yaml (1.0.4) - sass (3.4.23) + sass (3.4.24) scss_lint (0.53.0) rake (>= 0.9, < 13) sass (~> 3.4.20) PLATFORMS ruby + x64-mingw32 DEPENDENCIES jekyll (~> 3.4.3) jekyll-redirect-from (~> 0.12.1) jekyll-sitemap (~> 1.1.1) + jekyll-toc (~> 0.3.0.pre1) scss_lint (~> 0.53.0) BUNDLED WITH - 1.14.6 + 1.15.0 diff --git a/README.md b/README.md index 3e7258091a..7b38f9aec4 100644 --- a/README.md +++ b/README.md @@ -83,6 +83,8 @@ Have a bug or a feature request? Please first read the [issue guidelines](https: Bootstrap's documentation, included in this repo in the root directory, is built with [Jekyll](https://jekyllrb.com) and publicly hosted on GitHub Pages at . The docs may also be run locally. +Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in the `_scripts.html` include. + ### Running documentation locally 1. Run through the [tooling setup](https://github.com/twbs/bootstrap/blob/v4-dev/docs/getting-started/build-tools.md#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`. diff --git a/_config.yml b/_config.yml index 96ffe8f9d7..ebf6e74e78 100644 --- a/_config.yml +++ b/_config.yml @@ -9,18 +9,18 @@ kramdown: permalink: pretty # Server -source: docs -destination: _gh_pages -host: 0.0.0.0 +source: . +destination: ./_gh_pages port: 9001 baseurl: "" -url: https://v4-alpha.getbootstrap.com +url: https://getbootstrap.com encoding: UTF-8 -exclude: [assets/scss/] +exclude: [.git, .github, assets/scss/, build, js, node_modules, nuget, scss, vendor, bower.json, composer.json, Gemfile, Gemfile.lock, Gruntfile.js, package.js, package.json, sache.json] gems: - jekyll-redirect-from - jekyll-sitemap + - jekyll-toc # Social title: Bootstrap @@ -32,6 +32,7 @@ social_image_path: /assets/brand/bootstrap-social.png # Custom vars current_version: 4.0.0-alpha.6 +docs_version: 4.0 repo: https://github.com/twbs/bootstrap slack: https://bootstrap-slack.herokuapp.com @@ -42,6 +43,7 @@ download: blog: https://blog.getbootstrap.com expo: https://expo.getbootstrap.com themes: https://themes.getbootstrap.com +jobs: https://jobs.getbootstrap.com cdn: # See https://www.srihash.org for info on how to generate the hashes diff --git a/docs/_data/breakpoints.yml b/_data/breakpoints.yml similarity index 100% rename from docs/_data/breakpoints.yml rename to _data/breakpoints.yml diff --git a/docs/_data/browser-bugs.yml b/_data/browser-bugs.yml similarity index 100% rename from docs/_data/browser-bugs.yml rename to _data/browser-bugs.yml diff --git a/docs/_data/browser-features.yml b/_data/browser-features.yml similarity index 100% rename from docs/_data/browser-features.yml rename to _data/browser-features.yml diff --git a/docs/_data/core-team.yml b/_data/core-team.yml similarity index 100% rename from docs/_data/core-team.yml rename to _data/core-team.yml diff --git a/docs/_data/nav.yml b/_data/nav.yml similarity index 91% rename from docs/_data/nav.yml rename to _data/nav.yml index 3a335b7800..a66ed3d007 100644 --- a/docs/_data/nav.yml +++ b/_data/nav.yml @@ -74,12 +74,12 @@ # - title: Approach - title: Icons -- title: About - pages: - - title: History - - title: Team - - title: Brand - - title: License - - title: Translations +# - title: About +# pages: +# - title: History +# - title: Team +# - title: Brand +# - title: License +# - title: Translations - title: Migration diff --git a/docs/_data/showcase.yml b/_data/showcase.yml similarity index 100% rename from docs/_data/showcase.yml rename to _data/showcase.yml diff --git a/docs/_data/translations.yml b/_data/translations.yml similarity index 100% rename from docs/_data/translations.yml rename to _data/translations.yml diff --git a/docs/_includes/ads.html b/_includes/ads.html similarity index 100% rename from docs/_includes/ads.html rename to _includes/ads.html diff --git a/docs/_includes/callout-danger-async-methods.md b/_includes/callout-danger-async-methods.md similarity index 100% rename from docs/_includes/callout-danger-async-methods.md rename to _includes/callout-danger-async-methods.md diff --git a/docs/_includes/callout-warning-color-assistive-technologies.md b/_includes/callout-warning-color-assistive-technologies.md similarity index 100% rename from docs/_includes/callout-warning-color-assistive-technologies.md rename to _includes/callout-warning-color-assistive-technologies.md diff --git a/_includes/docs-navbar.html b/_includes/docs-navbar.html new file mode 100644 index 0000000000..0b2401d4db --- /dev/null +++ b/_includes/docs-navbar.html @@ -0,0 +1,63 @@ +
+ + {% include icons/bootstrap.svg width="36" height="36" class="d-block" %} + + +
+ +
+ + + + Download +
diff --git a/docs/_includes/nav-docs.html b/_includes/docs-sidebar.html similarity index 69% rename from docs/_includes/nav-docs.html rename to _includes/docs-sidebar.html index 89ca747a9b..71ea14f7d8 100644 --- a/docs/_includes/nav-docs.html +++ b/_includes/docs-sidebar.html @@ -1,9 +1,11 @@ -
+ - +
-