Bootstrap/_config.yml

# Dependencies
markdown:       kramdown
highlighter:    rouge

kramdown:
  auto_ids:     true

# Permalinks
permalink:      pretty

# Server
source:         "site"
destination:    ./_gh_pages
host:           "localhost"
port:           9001
baseurl:        ""
url:            "https://getbootstrap.com"
encoding:       UTF-8
exclude:
  - docs/4.5/assets/scss/

plugins:
  - jekyll-redirect-from
  - jekyll-sitemap
  - jekyll-toc

redirect_from:
  json: false

# Social
title:              Bootstrap
description:        "The most popular HTML, CSS, and JS library in the world."
twitter:            getbootstrap
authors:            "Mark Otto, Jacob Thornton, and Bootstrap contributors"
social_image_path:  /docs/4.5/assets/brand/bootstrap-social.png
social_logo_path:   /docs/4.5/assets/brand/bootstrap-social-logo.png

# Custom variables
current_version:      4.5.0
current_ruby_version: 4.5.0
docs_version:         4.5
github_org:           "https://github.com/twbs"
repo:                 "https://github.com/twbs/bootstrap"
slack:                "https://bootstrap-slack.herokuapp.com"
opencollective:       "https://opencollective.com/bootstrap"
blog:                 "https://blog.getbootstrap.com"
expo:                 "https://expo.getbootstrap.com"
themes:               "https://themes.getbootstrap.com"
icons:                "https://icons.getbootstrap.com"

download:
  source:           "https://github.com/twbs/bootstrap/archive/v4.5.0.zip"
  dist:             "https://github.com/twbs/bootstrap/releases/download/v4.5.0/bootstrap-4.5.0-dist.zip"
  dist_examples:    "https://github.com/twbs/bootstrap/releases/download/v4.5.0/bootstrap-4.5.0-examples.zip"

cdn:
  # See https://www.srihash.org for info on how to generate the hashes
  css:              "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"
  css_hash:         "sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"
  js:               "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"
  js_hash:          "sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6"
  js_bundle:        "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.bundle.min.js"
  js_bundle_hash:   "sha384-6khuMg9gaYr5AxOqhkVIODVIvm9ynTT5J4V1cfthmT+emCG6yVmEZsRHdxlotUnm"
  jquery:           "https://code.jquery.com/jquery-3.5.1.slim.min.js"
  jquery_hash:      "sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj"
  popper:           "https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"
  popper_hash:      "sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"

toc:
  min_level:        2
  max_level:        4
  no_toc_section_class:
    - "bd-callout"
    - "bd-example"
Make example pages use Jekyll; add sticky footer navbar image to examples 2013-02-15 08:38:00 +01:00			`# Dependencies`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`markdown: kramdown`
			`highlighter: rouge`
Make example pages use Jekyll; add sticky footer navbar image to examples 2013-02-15 08:38:00 +01:00
start markdowning getting started and moving things to separate pages 2014-07-11 02:54:06 +02:00			`kramdown:`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`auto_ids: true`
start markdowning getting started and moving things to separate pages 2014-07-11 02:54:06 +02:00
Make example pages use Jekyll; add sticky footer navbar image to examples 2013-02-15 08:38:00 +01:00			`# Permalinks`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`permalink: pretty`
Make example pages use Jekyll; add sticky footer navbar image to examples 2013-02-15 08:38:00 +01:00
			`# Server`
Reorganize docs for easier deploys With the current docs directory setup, I'm making too many mistakes and have to manually address path changes and directory moves on deploy. This makes for a frustrating experience developing locally and shipping releases. With this PR, we're basically back to the same setup from v3—duplicating the dist directory into our docs directory. Not the most ideal, but very straightforward for me as the release manager. 2018-06-21 06:31:38 +02:00			`source: "site"`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`destination: ./_gh_pages`
Jekyll: switch to localhost `0.0.0.0` has issues on Windows. 2018-10-30 12:13:17 +01:00			`host: "localhost"`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`port: 9001`
			`baseurl: ""`
			`url: "https://getbootstrap.com"`
			`encoding: UTF-8`
			`exclude:`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`- docs/4.5/assets/scss/`
Use some vars for key urls for easier updating 2013-07-27 04:05:43 +02:00
Update Jekyll to v3.5.1. 2017-08-10 05:48:50 +02:00			`plugins:`
add redirects for all top level docs sections 2015-08-18 05:34:11 +02:00			`- jekyll-redirect-from`
Use jekyll-sitemap instead of our custom solution. 2015-09-08 07:13:48 +02:00			`- jekyll-sitemap`
swap kramdown toc for jekyll-toc plugin, update page layout to only show on xl and above 2017-05-28 06:44:42 +02:00			`- jekyll-toc`
themes link 2015-08-19 08:19:38 +02:00
Update devDependencies and gems. 2020-02-17 10:53:24 +01:00			`redirect_from:`
			`json: false`

v4: Social meta tags (#20825) * descriptions for getting started pages * descriptions for layout * add content page descriptions * more descriptions, updates to some existing ones * correct site url * add social stuff to config for twitter cards * add twitter meta tags; use large image for homepage and regular card for all others * add the assets * more site config * more social shiz to partial, remove existing meta for the partial, remove page title from homepage for simpler if statements 2016-10-03 03:19:47 +02:00			`# Social`
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`title: Bootstrap`
			`description: "The most popular HTML, CSS, and JS library in the world."`
			`twitter: getbootstrap`
			`authors: "Mark Otto, Jacob Thornton, and Bootstrap contributors"`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`social_image_path: /docs/4.5/assets/brand/bootstrap-social.png`
			`social_logo_path: /docs/4.5/assets/brand/bootstrap-social-logo.png`
fixes #10372: two download buttons on homepage; also fixes broke button styles 2013-09-03 05:20:47 +02:00
Beautify _config.yml. (#23448) 2017-08-15 13:25:19 +02:00			`# Custom variables`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`current_version: 4.5.0`
			`current_ruby_version: 4.5.0`
			`docs_version: 4.5`
Backport #30041 and #30448 Switch links to the GitHub organization and fix redirected links 2020-03-25 15:38:44 +01:00			`github_org: "https://github.com/twbs"`
new current_ruby-version var 2017-10-19 20:26:14 +02:00			`repo: "https://github.com/twbs/bootstrap"`
			`slack: "https://bootstrap-slack.herokuapp.com"`
Add Open Collective to header (#27916) 2018-12-23 21:24:25 +01:00			`opencollective: "https://opencollective.com/bootstrap"`
new current_ruby-version var 2017-10-19 20:26:14 +02:00			`blog: "https://blog.getbootstrap.com"`
			`expo: "https://expo.getbootstrap.com"`
			`themes: "https://themes.getbootstrap.com"`
Backport #29544 Add link to Icons site in our docs 2019-10-18 09:30:34 +02:00			`icons: "https://icons.getbootstrap.com"`
More vars work 2013-07-27 04:24:59 +02:00
Normalize all links. (#24109) * use a trailing slash when possible * use https when possible * remove a few redirected links * consistently use `https://popper.js.org/` * fix `iconUrl` in nuget files * change Jekyll Windows guide to the official one 2017-09-26 14:24:14 +02:00			`download:`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`source: "https://github.com/twbs/bootstrap/archive/v4.5.0.zip"`
			`dist: "https://github.com/twbs/bootstrap/releases/download/v4.5.0/bootstrap-4.5.0-dist.zip"`
			`dist_examples: "https://github.com/twbs/bootstrap/releases/download/v4.5.0/bootstrap-4.5.0-examples.zip"`
Normalize all links. (#24109) * use a trailing slash when possible * use https when possible * remove a few redirected links * consistently use `https://popper.js.org/` * fix `iconUrl` in nuget files * change Jekyll Windows guide to the official one 2017-09-26 14:24:14 +02:00
Rearrange repository contents because muahahahahahaha 2013-12-29 07:47:03 +01:00			`cdn:`
Port #17729 to v4: Add SRI hashes to CDN links in docs [skip sauce] 2015-10-24 07:35:22 +02:00			`# See https://www.srihash.org for info on how to generate the hashes`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`css: "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css"`
Release v4.4.1. 2019-11-28 13:37:56 +01:00			`css_hash: "sha384-Vkoo8x4CGsO3+Hhxv8T/Q5PaXtkKtu6ug5TOeNV6gBiFeWPGFN9MuhOf23Q9Ifjh"`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`js: "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js"`
Release v4.4.1. 2019-11-28 13:37:56 +01:00			`js_hash: "sha384-wfSDF2E50Y2D1uUdj0O3uMBJnjuUD4Ih7YwaYd1iqfktj0Uod8GCExl3Og8ifwB6"`
Bump version to 4.5.0. 2020-05-12 18:04:19 +02:00			`js_bundle: "https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.bundle.min.js"`
Release v4.4.1. 2019-11-28 13:37:56 +01:00			`js_bundle_hash: "sha384-6khuMg9gaYr5AxOqhkVIODVIvm9ynTT5J4V1cfthmT+emCG6yVmEZsRHdxlotUnm"`
Update jQuery to v3.5.1. 2020-05-05 07:09:49 +02:00			`jquery: "https://code.jquery.com/jquery-3.5.1.slim.min.js"`
			`jquery_hash: "sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj"`
Backport #29624 config.yml: update popper.js to v1.16.0 2019-11-12 08:40:29 +01:00			`popper: "https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js"`
			`popper_hash: "sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo"`
Update devDependencies and gems. (#24940) 2017-12-05 00:02:29 +01:00
			`toc:`
			`min_level: 2`
			`max_level: 4`
Remove `no_toc_section`. 2018-11-28 18:55:41 +01:00			`no_toc_section_class:`
			`- "bd-callout"`
Configure multiple no_toc_section classes 2018-11-28 15:06:30 +01:00			`- "bd-example"`