Skip to content

Commit df6814c

Browse files
Merge branch 'prebid:master' into master
2 parents 494b6aa + b3bc741 commit df6814c

1,301 files changed

Lines changed: 63957 additions & 59582 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/pull_request_template.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
1+
<!--
12
Thanks for improving the documentation 😃
23
Please give a short description and check the matching checkboxes to help us review this as quick as possible.
34
4-
## 🏷 Type of documentation
5+
Please make the PR writeable. This allows us to fix typos, grammar and linting errors ourselves, which makes
6+
merging and reviewing a lot faster for everybody.
7+
-->
58

9+
## 🏷 Type of documentation
10+
<!-- Remove items that don't apply and/or select an item by changing [ ] to [x] -->
611
- [ ] new bid adapter
712
- [ ] update bid adapter
813
- [ ] new feature
@@ -11,6 +16,6 @@ Please give a short description and check the matching checkboxes to help us rev
1116
- [ ] new examples
1217

1318
## 📋 Checklist
14-
15-
- [ ] Related pull requests in prebid.js or server are linked
19+
<!-- Remove items that don't apply and/or select an item by changing [ ] to [x] -->
20+
- [ ] Related pull requests in prebid.js or server are linked -> Paste link in this list or reference it on the PR itself
1621
- [ ] For new adapters check [submitting your adapter docs](https://docs.prebid.org/dev-docs/bidder-adaptor.html#submitting-your-adapter)

.github/workflows/ci.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Continuous Integration
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- master
7+
push:
8+
branches:
9+
- master
10+
11+
jobs:
12+
# based on https://github.com/DavidAnson/markdownlint-cli2-action/blob/main/.github/workflows/changed.yml
13+
# runs markdown lint only for changed files
14+
markdownlint:
15+
name: run markdownlint
16+
runs-on: ubuntu-latest
17+
steps:
18+
- uses: actions/checkout@v3
19+
with:
20+
fetch-depth: 0
21+
- uses: tj-actions/changed-files@v37
22+
id: changed-files
23+
with:
24+
files: '**/*.md'
25+
separator: ","
26+
- uses: DavidAnson/markdownlint-cli2-action@v11
27+
if: steps.changed-files.outputs.any_changed == 'true'
28+
with:
29+
globs: ${{ steps.changed-files.outputs.all_changed_files }}
30+
separator: ","
31+
config: '.markdownlint.json'

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ Gemfile.lock
33
/dist/bootstrap
44
/dist/jquery
55
/.idea
6+
/.vscode
67
.DS_Store
78
/vendor
89
/.bundle
@@ -12,3 +13,6 @@ Gemfile.lock
1213

1314
# Files generated by `npm install`
1415
node_modules/
16+
/.vs/prebid.github.io/v17/.suo
17+
/.vs/slnx.sqlite
18+
/.vs

.markdownlint.json

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD022": false,
5+
"MD024": false,
6+
"MD025": false,
7+
"MD033": false,
8+
"MD036": false
9+
}

.ruby-version

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.7.6

Gemfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
source 'https://rubygems.org'
2-
gem 'github-pages', '>= 30'
2+
gem 'github-pages', '>= 228'
33

44
gem "webrick", "~> 1.7"

README.md

Lines changed: 35 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
1+
# docs.prebid.org source
2+
13
This repository contains the source files for the Prebid.js documentation site at [Prebid.org](https://prebid.org).
24

35
Please see the sections below for more information:
46

5-
+ [Contributing](#contributing)
6-
+ [License](#license)
7-
+ [Prerequisites](#prerequisites)
8-
+ [Running Jekyll Locally](#running-jekyll-locally)
9-
+ [Building Assets](#building-assets)
10-
+ [The Downloads Page](#the-downloads-page)
11-
+ [Thanks](#thanks)
7+
* [Contributing](#contributing)
8+
* [License](#license)
9+
* [Prerequisites](#prerequisites)
10+
* [Running Jekyll Locally](#running-jekyll-locally)
11+
* [Building Assets](#building-assets)
12+
* [The Downloads Page](#the-downloads-page)
13+
* [Thanks](#thanks)
1214

13-
<a name="contributing" />
15+
<a name="contributing"></a>
1416

1517
## Contributing
1618

@@ -20,32 +22,39 @@ For smaller changes, such as fixing a typo or adding a new section to an existin
2022

2123
For larger changes such as reorganizing the site and moving/removing content, you may want to open an issue so we can discuss the work beforehand. This is a good idea because:
2224

23-
+ We want to value your time, so you don't do unnecessary work
24-
+ We want to value our users' time; we don't want to break links and bookmarks for users
25+
* We want to value your time, so you don't do unnecessary work
26+
* We want to value our users' time; we don't want to break links and bookmarks for users
2527

26-
<a name="license" />
28+
<a name="license"></a>
2729

2830
## License
2931

3032
All docs are under the license shown in the `LICENSE` file in this directory.
3133

32-
<a name="prerequisites" />
34+
<a name="prerequisites"></a>
3335

3436
## Prerequisites
3537

3638
The site is hosted on GitHub pages, and uses [Jekyll](https://jekyllrb.com/) to generate the HTML. Jekyll is written in the [Ruby](https://www.ruby-lang.org/en/) language.
3739

38-
1. follow the instructions at https://jekyllrb.com/docs/installation/ for your OS
40+
1. follow the instructions at [jekyllrb.com/docs/installation/](https://jekyllrb.com/docs/installation/) for your OS
3941
1. gem install github-pages
4042
1. start Jekyll as described below
4143

4244
For CSS, the site uses Laravel Mix to build CSS from Sass (scss-flavored) source files. Under the hood Laravel Mix uses Webpack.
4345

44-
1. follow the instructions at https://nodejs.dev to install Node.js for your OS
46+
1. follow the instructions at [/nodejs.dev](https://nodejs.dev) to install Node.js for your OS
4547
1. `npm ci` to install packages for building assets
4648
1. build assets as described below
4749

48-
<a name="running-jekyll-locally" />
50+
The markdown files are linted via [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). VSCode supports the [.markdownlintignore](.markdownlintignore) file.
51+
You may need to configure the disabled rules specified in [.markdownlint.json](.markdownlint.json) directly in your project settings. You can invoke linting in CLI via
52+
53+
```bash
54+
markdownlint --config .markdownlint.json --ignore-path .markdownlintignore "**/*.md"
55+
```
56+
57+
<a name="running-jekyll-locally"></a>
4958

5059
## Running Jekyll Locally
5160

@@ -54,13 +63,12 @@ Before submitting a pull request, you should run the site locally to make sure y
5463
To get started editing the site and seeing your changes, clone this repo and enter the following commands in your terminal:
5564

5665
```bash
57-
$ JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
66+
JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
5867
```
5968

60-
6169
You should see output that looks something like this:
6270

63-
```
71+
```bash
6472
Configuration file: /Users/me/git/prebid.github.io/_config.yml
6573
Source: /Users/me/git/prebid.github.io
6674
Destination: /Users/me/git/prebid.github.io/_site
@@ -77,13 +85,13 @@ Configuration file: /Users/me/git/prebid.github.io/_config.yml
7785

7886
Open the `Server address` URL in your browser, and you should see a locally running copy of the site.
7987

80-
<a name="building-assets"/>
88+
<a name="building-assets"></a>
8189

8290
## Building Assets
8391

84-
- `npm run dev` to build unminified CSS for development
85-
- `npm run prod` to build minified CSS for production
86-
- `npm run watch` to use [Browsersync](https://browsersync.io) to rebuild CSS on demand and reload the browser
92+
* `npm run dev` to build unminified CSS for development
93+
* `npm run prod` to build minified CSS for production
94+
* `npm run watch` to use [Browsersync](https://browsersync.io) to rebuild CSS on demand and reload the browser
8795

8896
## The Downloads Page
8997

@@ -98,7 +106,11 @@ The Downloads page is generated from [the Markdown bidder adapter docs](https://
98106

99107
This means an adaptor is not available to download from Prebid.org as soon as the code gets merged into Prebid.js - it will be available after the next release (usually in a couple of weeks).
100108

101-
<a name="thanks" />
109+
<a name="thanks"></a>
110+
111+
## Liquid Templating
112+
113+
* [jekyll - check for non empty](https://michaelcurrin.github.io/dev-cheatsheets/cheatsheets/jekyll/liquid/conditionals/non-empty.html)
102114

103115
## Thanks
104116

_assets/sass/abstracts/_breakpoints.scss

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
// Breakpoint Declarations
22
//
33
// Responsive breakpoint declarations
4-
// Breakpoints are matched in Responsive VC Design Options Plugin
5-
// http://actian/wp-admin/admin.php?page=bb_edo_all_devices
4+
// Breakpoints are matched in Responsive VC Design Options Plugin
5+
// http://actian/wp-admin/admin.php?page=bb_edo_all_devices
66
//
7-
// Markup:
8-
// 'phone-xs': 320px,
9-
// 'phone-sm': 480px,
10-
// 'phone': 767px, // Page Builder Default
11-
// 'tablet': 960px, // Page Builder Default
12-
// 'desktop-sm': 1200px,
13-
// 'desktop': 1980px,
7+
// Markup:
8+
// 'phone-xs': 320px,
9+
// 'phone-sm': 480px,
10+
// 'phone': 767px, // Page Builder Default
11+
// 'tablet': 960px, // Page Builder Default
12+
// 'desktop-sm': 1200px,
13+
// 'desktop': 1980px,
1414
//
1515
// Styleguide Layout.Breakpoints
1616

_assets/sass/abstracts/_mixins.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@
145145
@mixin ie10-and-up {
146146
@media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
147147
@content
148-
}
148+
}
149149
}
150150

151151
// linear-gradient

_assets/sass/base/_base.scss

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
11
img {
22
max-width: 100%;
33
}
4+
5+
div {
6+
min-width: 0;
7+
}
8+
9+

0 commit comments

Comments
 (0)