Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch to Hugo #28014

Merged
merged 23 commits into from Mar 13, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
9ff00a6
Switch to Hugo.
XhmikosR Jan 8, 2019
2f06a9a
browsers-devices.md: Read .browserslistrc instead of duplicating the …
XhmikosR Jan 27, 2019
8651462
Remove HTML comment; it breaks rendering.
XhmikosR Jan 28, 2019
2e3476e
Copy the dist files before the `docs-serve` script.
XhmikosR Jan 28, 2019
e4c7f85
Remove newlines in raw HTML.
XhmikosR Jan 30, 2019
adcbcb8
Work around the docs/ redirects.
XhmikosR Feb 11, 2019
86b5494
Move this to a partial to work around the stray `p` issue.
XhmikosR Feb 4, 2019
0e6dc85
Add a docsref shortcode.
XhmikosR Feb 4, 2019
c53a1fe
Update syntax highlighting styles to match the Chroma ones.
XhmikosR Feb 4, 2019
7ffb263
Fix bugify.
bep Feb 5, 2019
9674caf
Add a `docs-build` script and make it the default.
XhmikosR Feb 5, 2019
4f8ff70
Simplify browser bugs inline shortcode
bep Feb 5, 2019
6fb4b21
Remove `--renderToDisk`.
XhmikosR Feb 7, 2019
c471005
Add support for meta robots.
XhmikosR Feb 21, 2019
dc2bc60
Disable blackfriday's automatic fraction formatting.
bardiharborow Feb 27, 2019
8ada65a
Workaround problematic Chroma bash highlighting.
bardiharborow Feb 27, 2019
1b754bb
Fix the chroma fix and use Sass more.
XhmikosR Feb 27, 2019
9371262
Create 404.md
coliff Feb 21, 2019
5e3e75f
404: output to 404.html and add meta robots.
XhmikosR Feb 21, 2019
baf77d7
Fix 404 layout.
XhmikosR Feb 27, 2019
c8f4cc5
Push footer to the bottom of the page
MartijnCuppens Feb 27, 2019
ece9c59
Don't run Google Analytics locally. (#28384)
coliff Mar 13, 2019
235d1db
Merge branch 'master' into v4-dev-xmr-hugo-2
XhmikosR Mar 13, 2019
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Expand Up @@ -140,7 +140,7 @@ and/or [`/bootstrap/js/src/`](https://github.com/twbs/bootstrap/tree/master/js/s

Similarly, when contributing to Bootstrap's documentation, you should edit the
documentation source files in
[the `/bootstrap/site/docs/` directory of the `master` branch](https://github.com/twbs/bootstrap/tree/master/site/docs).
[the `/bootstrap/site/content/docs/` directory of the `master` branch](https://github.com/twbs/bootstrap/tree/master/site/content/docs).
**Do not edit the `gh-pages` branch.** That branch is generated from the
documentation source files and is managed separately by the Bootstrap Core Team.

Expand Down
9 changes: 2 additions & 7 deletions .gitignore
@@ -1,12 +1,7 @@
# Ignore docs files
/_gh_pages/
/site/.jekyll-metadata
/site/docs/**/dist/

# Ignore ruby/bundler files
/.bundle/
/vendor/
/.ruby-version
/site/static/**/dist/
/resources/

# Numerous always-ignore extensions
*.diff
Expand Down
4 changes: 0 additions & 4 deletions .travis.yml
Expand Up @@ -6,9 +6,6 @@ git:
node_js:
- "8"
- "10"
install:
- bundle install --deployment --jobs=3 --retry=3 --clean
- npm ci
before_script:
- google-chrome-stable --product-version
script:
Expand All @@ -20,6 +17,5 @@ after_success:
cache:
directories:
- "$HOME/.npm"
- vendor/bundle
notifications:
email: false
9 changes: 0 additions & 9 deletions Gemfile

This file was deleted.

82 changes: 0 additions & 82 deletions Gemfile.lock

This file was deleted.

14 changes: 7 additions & 7 deletions README.md
Expand Up @@ -111,18 +111,18 @@ Have a bug or a feature request? Please first read the [issue guidelines](https:

## Documentation

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 <https://getbootstrap.com/>. The docs may also be run locally.
Bootstrap's documentation, included in this repo in the root directory, is built with [Hugo](https://gohugo.io/) and publicly hosted on GitHub Pages at <https://getbootstrap.com/>. 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 `site/docs/4.3/assets/js/src/search.js` file.
Documentation search is powered by [Algolia's DocSearch](https://community.algolia.com/docsearch/). Working on our search? Be sure to set `debug: true` in `site/static/docs/4.3/assets/js/src/search.js` file.

### Running documentation locally

1. Run through the [tooling setup](https://getbootstrap.com/docs/4.3/getting-started/build-tools/#tooling-setup) to install Jekyll (the site builder) and other Ruby dependencies with `bundle install`.
2. Run `npm install` to install Node.js dependencies.
3. Run `npm start` to compile CSS and JavaScript files, generate our docs, and watch for changes.
4. Open `http://localhost:9001` in your browser, and voilà.
1. Run `npm install` to install the Node.js dependencies, including Hugo (the site builder).
2. Run `npm run test` (or a specific npm script) to rebuild distributed CSS and JavaScript files, as well as our docs assets.
3. From the root `/bootstrap` directory, run `npm run docs-serve` in the command line.
4. Open `http://localhost:9001/` in your browser, and voilà.

Learn more about using Jekyll by reading its [documentation](https://jekyllrb.com/docs/).
Learn more about using Hugo by reading its [documentation](https://gohugo.io/documentation/).

### Documentation for previous releases

Expand Down
66 changes: 0 additions & 66 deletions _config.yml

This file was deleted.

4 changes: 2 additions & 2 deletions build/generate-sri.js
Expand Up @@ -19,11 +19,11 @@ const sh = require('shelljs')

sh.config.fatal = true

const configFile = path.join(__dirname, '../_config.yml')
const configFile = path.join(__dirname, '../config.yml')

// Array of objects which holds the files to generate SRI hashes for.
// `file` is the path from the root folder
// `configPropertyName` is the _config.yml variable's name of the file
// `configPropertyName` is the config.yml variable's name of the file
const files = [
{
file: 'dist/css/bootstrap.min.css',
Expand Down
58 changes: 58 additions & 0 deletions config.yml
@@ -0,0 +1,58 @@
languageCode: "en"
title: "Bootstrap"
baseURL: "https://getbootstrap.com"
enableInlineShortcodes: true

pygmentsUseClasses: true
# you can use ```lang if you want too
pygmentsCodeFences: true

buildDrafts: true
buildFuture: true

enableRobotsTXT: true
metaDataFormat: "yaml"
disableKinds: ["404", "taxonomy", "taxonomyTerm", "RSS"]

blackfriday:
fractions: false

XhmikosR marked this conversation as resolved.
Show resolved Hide resolved
publishDir: "_gh_pages"
archetypeDir: "site/archetypes"
assetDir: "site/assets"
contentDir: "site/content"
dataDir: "site/data"
layoutDir: "site/layouts"
staticDir: "site/static"
themesDir: "site/themes"

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

current_version: "4.3.1"
current_ruby_version: "4.3.1"
docs_version: "4.3"
repo: "https://github.com/twbs/bootstrap"
twitter: "getbootstrap"
slack: "https://bootstrap-slack.herokuapp.com"
blog: "https://blog.getbootstrap.com"
expo: "https://expo.getbootstrap.com"
themes: "https://themes.getbootstrap.com"

download:
source: "https://github.com/twbs/bootstrap/archive/v4.3.1.zip"
dist: "https://github.com/twbs/bootstrap/releases/download/v4.3.1/bootstrap-4.3.1-dist.zip"

cdn:
# See https://www.srihash.org for info on how to generate the hashes
css: "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css"
css_hash: "sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T"
js: "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js"
js_hash: "sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM"
js_bundle: "https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.bundle.min.js"
js_bundle_hash: "sha384-xrRywqdh3PHs8keKZN+8zzc5TX0GRTLCcmivcbNJWm2rs5C8PRhcEn3czEjhAO9o"
popper: "https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.14.7/umd/popper.min.js"
popper_hash: "sha384-UO2eT0CpHqdSJQ6hJty5KVphtPhzWj9WO1clHTMGa3JDZwrnQq4sF86dIHNDz0W1"