Skip to content

feat(docs): migrate to GitHub Pages #7229

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

Merged
merged 25 commits into from
Mar 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
2ee86fb
fix: update Nuxt dependencies to support Node 20
jacobmllr95 Jan 4, 2025
711e4c6
feat: add new "docs deploy" workflow
jacobmllr95 Jan 4, 2025
bf2ff74
fix: remove Netlify references
jacobmllr95 Jan 4, 2025
be3faf4
fix: replace polyfill.io with Cloudflare's polyfills
jacobmllr95 Jan 4, 2025
b72dd05
fix(docs): use `static` as target
jacobmllr95 Jan 4, 2025
2d80505
fix(docs): base URL handling
jacobmllr95 Jan 4, 2025
f682e53
feat(docs): remove Carbon ads
jacobmllr95 Jan 4, 2025
9229887
fix(docs): remove Vercel references
jacobmllr95 Jan 4, 2025
353b3d9
feat(docs): remove themes page
jacobmllr95 Jan 4, 2025
c3d6875
fix: remove "jackmu95" references
jacobmllr95 Jan 4, 2025
0be53e2
feat(docs): use Bootstrap Icons in header
jacobmllr95 Jan 4, 2025
11505a0
fix(docs): remove outdated `CNAME` file
jacobmllr95 Jan 4, 2025
d42c3fc
fix(docs): use components for all icons
jacobmllr95 Jan 4, 2025
5f7e62c
fix(ci): bump Node.js versions to currently maintained versions
jacobmllr95 Jan 5, 2025
864827b
fix(docs): Open Collective icon until Bootstrap Icons are updated
jacobmllr95 Jan 5, 2025
8071b93
fix(docs): correct header dropdown
jacobmllr95 Jan 5, 2025
60c8e2c
Merge branch 'dev' into docs-github-pages
jacobmllr95 Jan 5, 2025
f09384a
fix: add missing comma
jacobmllr95 Jan 5, 2025
d563130
fix: update copyright year
jacobmllr95 Jan 5, 2025
2894d62
feat: update dependencies
jacobmllr95 Jan 5, 2025
0111d3e
fix: ignore "GHSA-vc8w-jr9v-vj7f" in audit
jacobmllr95 Jan 5, 2025
f56b381
chore(icons): update Bootstrap Icons to v1.11.0
jacobmllr95 Jan 5, 2025
3785994
Revert "fix(docs): Open Collective icon until Bootstrap Icons are upd…
jacobmllr95 Jan 5, 2025
21ff743
fix: bundle sizes
jacobmllr95 Jan 5, 2025
da73b78
fix: badges
jacobmllr95 Jan 5, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .bundlewatch.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,27 +2,27 @@
"files": [
{
"path": "./dist/bootstrap-vue-icons.js",
"maxSize": "155 kB"
"maxSize": "240 kB"
},
{
"path": "./dist/bootstrap-vue-icons.min.js",
"maxSize": "145 kB"
"maxSize": "230 kB"
},
{
"path": "./dist/bootstrap-vue-icons.common.js",
"maxSize": "155 kB"
"maxSize": "250 kB"
},
{
"path": "./dist/bootstrap-vue-icons.common.min.js",
"maxSize": "145 kB"
"maxSize": "240 kB"
},
{
"path": "./dist/bootstrap-vue-icons.esm.js",
"maxSize": "155 kB"
"maxSize": "245 kB"
},
{
"path": "./dist/bootstrap-vue-icons.esm.min.js",
"maxSize": "145 kB"
"maxSize": "235 kB"
},
{
"path": "./dist/bootstrap-vue-icons.css",
Expand All @@ -42,27 +42,27 @@
},
{
"path": "./dist/bootstrap-vue.common.js",
"maxSize": "360 kB"
"maxSize": "455 kB"
},
{
"path": "./dist/bootstrap-vue.common.min.js",
"maxSize": "240 kB"
"maxSize": "330 kB"
},
{
"path": "./dist/bootstrap-vue.esm.js",
"maxSize": "355 kB"
"maxSize": "450 kB"
},
{
"path": "./dist/bootstrap-vue.esm.min.js",
"maxSize": "235 kB"
"maxSize": "330 kB"
},
{
"path": "./dist/bootstrap-vue.css",
"maxSize": "15 kB"
},
{
"path": "./dist/bootstrap-vue.min.css",
"maxSize": "10 kB"
"maxSize": "15 kB"
}
],
"ci": {
Expand Down
2 changes: 0 additions & 2 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.now/
.nuxt/
.vercel/
coverage/
dist/
docs-dist/
Expand Down
46 changes: 21 additions & 25 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,40 +1,36 @@
version: 2
updates:
- package-ecosystem: "github-actions"
directory: "/"
- package-ecosystem: 'github-actions'
directory: '/'
schedule:
interval: weekly
day: tuesday
time: "12:00"
time: '12:00'
timezone: Europe/Berlin
reviewers:
- jackmu95
labels:
- "Type: CI"
- "Type: Dependencies"
- 'Type: CI'
- 'Type: Dependencies'

- package-ecosystem: npm
directory: "/"
directory: '/'
schedule:
interval: "daily"
time: "12:00"
interval: 'daily'
time: '12:00'
timezone: Europe/Berlin
ignore:
- dependency-name: "bootstrap"
versions: [">=5.0.0"]
- dependency-name: "clean-css-cli"
versions: [">=5.0.0"]
- dependency-name: "html-loader"
versions: [">=2.0.0"]
- dependency-name: "prettier"
versions: [">1.14.3"]
- dependency-name: "sass-loader"
versions: [">=11.0.0"]
- dependency-name: "@vue/test-utils"
versions: [">=2.0.0"]
reviewers:
- jackmu95
- dependency-name: 'bootstrap'
versions: ['>=5.0.0']
- dependency-name: 'clean-css-cli'
versions: ['>=5.0.0']
- dependency-name: 'html-loader'
versions: ['>=2.0.0']
- dependency-name: 'prettier'
versions: ['>1.14.3']
- dependency-name: 'sass-loader'
versions: ['>=11.0.0']
- dependency-name: '@vue/test-utils'
versions: ['>=2.0.0']
labels:
- "Type: Dependencies"
- 'Type: Dependencies'
versioning-strategy: increase
rebase-strategy: disabled
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
node: [12, 14, 16]
node: [18, 20, 22]

steps:
- name: Clone repository
Expand Down Expand Up @@ -53,6 +53,6 @@ jobs:

- name: BundleWatch
run: yarn run bundlewatch
if: matrix.node == '16'
if: matrix.node == '20'
env:
BUNDLEWATCH_GITHUB_TOKEN: "${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}"
8 changes: 4 additions & 4 deletions .github/workflows/codeql.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,17 @@ permissions:
jobs:
analyze:
permissions:
actions: read # for github/codeql-action/init to get workflow details
contents: read # for actions/checkout to fetch code
security-events: write # for github/codeql-action/autobuild to send a status report
actions: read # For "github/codeql-action/init" to get workflow details
contents: read # For "actions/checkout to fetch" code
security-events: write # For "github/codeql-action/autobuild" to send a status report
name: Analyze
runs-on: ubuntu-latest

steps:
- name: Checkout repository
uses: actions/checkout@v3

# Initializes the CodeQL tools for scanning.
# Initializes the CodeQL tools for scanning
- name: Initialize CodeQL
uses: github/codeql-action/init@v2
with:
Expand Down
67 changes: 67 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
name: Deploy docs to GitHub Pages

on:
push:
branches:
- master
- docs-github-pages

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the "GITHUB_TOKEN" to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress
# and latest queued. However, do NOT cancel in-progress runs as we want to allow these
# production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "yarn"
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Restore cache
uses: actions/cache@v4
with:
path: |
dist
.nuxt
key: ${{ runner.os }}-nuxt-build-${{ hashFiles('dist') }}
restore-keys: |
${{ runner.os }}-nuxt-build-
- name: Install dependencies
run: yarn install --check-files --frozen-lockfile --non-interactive
- name: Static HTML export with Nuxt
run: yarn docs-gen
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./docs-dist

# Deploy
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
6 changes: 3 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
node: [16]
node: [20]

steps:
- name: Clone repository
Expand Down Expand Up @@ -57,7 +57,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
node: [16]
node: [20]

steps:
- name: Clone repository
Expand Down Expand Up @@ -94,7 +94,7 @@ jobs:
strategy:
matrix:
os: [ubuntu-latest]
node: [12, 14, 16]
node: [18, 20, 22]

steps:
- name: Clone repository
Expand Down
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.idea/
.now/
.nuxt/
.vercel/
.vscode/
coverage/
coverage-vue3/
Expand Down
2 changes: 0 additions & 2 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
.now/
.nuxt/
.vercel/
coverage/
dist/
docs-dist/
Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (c) 2016-2024 - BootstrapVue
Copyright (c) 2016-2025 - BootstrapVue

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
33 changes: 12 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,45 +15,42 @@

<p align="center">
<a href="https://www.npmjs.com/package/bootstrap-vue">
<img src="https://flat.badgen.net/npm/v/bootstrap-vue" alt="Current version">
<img src="https://badgen.net/npm/v/bootstrap-vue" alt="Current version">
</a>
<a href="https://getbootstrap.com/docs">
<img src="https://flat.badgen.net/badge/bootstrap/4.5.x/563d7c" alt="Bootstrap version">
<img src="https://badgen.net/badge/bootstrap/4.5.x/563d7c" alt="Bootstrap version">
</a>
<a href="https://vuejs.org">
<img src="https://flat.badgen.net/badge/vue.js/2.6.x/4fc08d" alt="Vue.js version">
<img src="https://badgen.net/badge/vue.js/2.6.x/4fc08d" alt="Vue.js version">
</a>
<a href="https://github.com/bootstrap-vue/bootstrap-vue/actions?workflow=Tests">
<img src="https://flat.badgen.net/github/status/bootstrap-vue/bootstrap-vue" alt="Build status">
</a>
<a href="https://github.com/bootstrap-vue/bootstrap-vue">
<img src="https://flat.badgen.net/david/dep/bootstrap-vue/bootstrap-vue" alt="Dependencies status">
<img src="https://badgen.net/github/checks/bootstrap-vue/bootstrap-vue/?label=status" alt="Build status">
</a>
<br>
<a href="https://codecov.io/gh/bootstrap-vue/bootstrap-vue">
<img src="https://flat.badgen.net/codecov/c/github/bootstrap-vue/bootstrap-vue" alt="Coverage">
<img src="https://badgen.net/codecov/c/github/bootstrap-vue/bootstrap-vue" alt="Coverage">
</a>
<a href="https://packagequality.com/#?package=bootstrap-vue">
<img src="https://npm.packagequality.com/shield/bootstrap-vue.svg?style=flat-square" alt="Package quality">
<img src="https://npm.packagequality.com/shield/bootstrap-vue.svg" alt="Package quality">
</a>
<a href="https://app.codacy.com/gh/bootstrap-vue/bootstrap-vue/dashboard">
<img src="https://flat.badgen.net/codacy/grade/8b19182d32514a83baac4dd0ccf5f35c" alt="Code quality">
<img src="https://badgen.net/codacy/grade/8b19182d32514a83baac4dd0ccf5f35c" alt="Code quality">
</a>
<a href="https://www.npmjs.com/package/bootstrap-vue">
<img src="https://flat.badgen.net/npm/dt/bootstrap-vue" alt="npm downloads">
<img src="https://badgen.net/npm/dt/bootstrap-vue" alt="npm downloads">
</a>
<a href="https://www.npmjs.com/package/bootstrap-vue">
<img src="https://flat.badgen.net/npm/dw/bootstrap-vue" alt="npm weekly downloads">
<img src="https://badgen.net/npm/dw/bootstrap-vue" alt="npm weekly downloads">
</a>
<br>
<a href="https://opencollective.com/bootstrap-vue#sponsor">
<img src="https://opencollective.com/bootstrap-vue/sponsors/badge.svg?style=flat-square" alt="Open Collective sponsors">
<img src="https://opencollective.com/bootstrap-vue/sponsors/badge.svg" alt="Open Collective sponsors">
</a>
<a href="https://opencollective.com/bootstrap-vue#backer">
<img src="https://flat.badgen.net/opencollective/backers/bootstrap-vue" alt="Open Collective backers">
<img src="https://badgen.net/opencollective/backers/bootstrap-vue" alt="Open Collective backers">
</a>
<a href="https://opencollective.com/bootstrap-vue">
<img src="https://flat.badgen.net/opencollective/balance/bootstrap-vue" alt="Open Collective balance">
<img src="https://badgen.net/opencollective/balance/bootstrap-vue" alt="Open Collective balance">
</a>
</p>

Expand Down Expand Up @@ -95,12 +92,6 @@ This project exists thanks to all the people who contribute. [[Contribute]](CONT

<a href="https://github.com/bootstrap-vue/bootstrap-vue/graphs/contributors"><img src="https://opencollective.com/bootstrap-vue/contributors.svg?width=890"></a>

<h2 align="center">Partners</h2>

<p align="center">
<a href="https://vercel.com/?utm_source=bootstrapvue" target="_blank" rel="noopener"><img src="https://github.com/bootstrap-vue/bootstrap-vue/raw/master/static/powered-by-vercel.svg" width="175" alt="Powered by Vercel"></a>
</p>

<h2 align="center">License</h2>

Released under the MIT [License](./LICENSE). Copyright (c) BootstrapVue.
Expand Down
6 changes: 0 additions & 6 deletions docs/assets/powered-by-vercel.svg

This file was deleted.

Loading
Loading