Back to Internal API Reference
+ +diff --git a/.bowerrc b/.bowerrc deleted file mode 100755 index a3ee2c7e39..0000000000 --- a/.bowerrc +++ /dev/null @@ -1,3 +0,0 @@ -{ - "directory": "/dist" -} \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a4c3c75d3e..f72c668240 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -18,14 +18,14 @@ jobs: - uses: actions/checkout@v3 with: fetch-depth: 0 - - uses: tj-actions/changed-files@v37 + - uses: tj-actions/changed-files@v41 id: changed-files with: files: '**/*.md' separator: "," - - uses: DavidAnson/markdownlint-cli2-action@v11 + - uses: DavidAnson/markdownlint-cli2-action@v15 if: steps.changed-files.outputs.any_changed == 'true' with: - globs: ${{ steps.changed-files.outputs.all_changed_files }} + globs: "${{ steps.changed-files.outputs.all_changed_files }},!_includes" separator: "," config: '.markdownlint.json' diff --git a/.gitignore b/.gitignore index ce3d4b80b2..3c50b583af 100755 --- a/.gitignore +++ b/.gitignore @@ -13,6 +13,7 @@ Gemfile.lock # Files generated by `npm install` node_modules/ +!_sass/node_modules /.vs/prebid.github.io/v17/.suo /.vs/slnx.sqlite /.vs diff --git a/.markdownlint.json b/.markdownlint.json index 1e340c476a..ef360a2bf6 100644 --- a/.markdownlint.json +++ b/.markdownlint.json @@ -1,5 +1,6 @@ { "default": true, + "MD009": false, "MD013": false, "MD022": false, "MD024": false, diff --git a/.sass-cache/a8ae1fbf8fe3cf0ae44282e4f927a25624204c54/main.scssc b/.sass-cache/a8ae1fbf8fe3cf0ae44282e4f927a25624204c54/main.scssc deleted file mode 100644 index 6db4f74c3a..0000000000 Binary files a/.sass-cache/a8ae1fbf8fe3cf0ae44282e4f927a25624204c54/main.scssc and /dev/null differ diff --git a/README.md b/README.md index 2e88456eaa..3825aa02c9 100755 --- a/README.md +++ b/README.md @@ -41,11 +41,11 @@ The site is hosted on GitHub pages, and uses [Jekyll](https://jekyllrb.com/) to 1. gem install github-pages 1. start Jekyll as described below -For CSS, the site uses Laravel Mix to build CSS from Sass (scss-flavored) source files. Under the hood Laravel Mix uses Webpack. +For CSS, the site uses Jekyll board tools to compile SCSS down to CSS. -1. follow the instructions at [/nodejs.dev](https://nodejs.dev) to install Node.js for your OS -1. `npm ci` to install packages for building assets -1. build assets as described below +1. Install `boostrap` via `npm install` to make the build work +1. [Jekyll assets management](https://jekyllrb.com/docs/assets/) +1. [Jekyll SASS plugin](https://jekyllrb.com/docs/configuration/sass/) The markdown files are linted via [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli). VSCode supports the [.markdownlintignore](.markdownlintignore) file. 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 diff --git a/_assets/sass/main.scss b/_assets/sass/main.scss deleted file mode 100644 index ad4090dbd6..0000000000 --- a/_assets/sass/main.scss +++ /dev/null @@ -1,43 +0,0 @@ -// General layout is according to https://sass-guidelin.es/#the-7-1-pattern - -// Abstracts should not output any CSS, they just help setup -// the environment - -// Abstracts -@import 'abstracts/colors'; -@import 'abstracts/tokens'; -@import 'abstracts/bootstrap-variables'; -@import 'abstracts/functions'; -@import 'abstracts/mixins'; -@import 'abstracts/breakpoints'; - -// Vendor Includes -@import 'vendor/bootstrap'; -@import 'vendor/bourbon'; -@import 'vendor/include-media'; -@import 'vendor/awesomplete'; - -// Base Styles -@import 'base/base'; -@import 'base/typography'; - -// Core Layout -@import 'layout/header'; -@import 'layout/sidebar'; -@import 'layout/footer'; - -// Components -@import 'components/card'; -@import 'components/banner'; -@import 'components/buttons'; -@import 'components/pb'; -@import 'components/social-media'; -@import 'components/table'; -@import 'components/download-form'; -@import 'components/autocomplete-filter'; -@import 'components/bidder-list'; -@import 'components/search'; - -// Pages -@import 'pages/home'; -@import 'pages/404'; diff --git a/_assets/sass/vendor/_bootstrap.scss b/_assets/sass/vendor/_bootstrap.scss deleted file mode 100644 index 0d44b0260c..0000000000 --- a/_assets/sass/vendor/_bootstrap.scss +++ /dev/null @@ -1,17 +0,0 @@ -@import "../../../node_modules/bootstrap/scss/functions"; -@import "../../../node_modules/bootstrap/scss/variables"; -@import "../../../node_modules/bootstrap/scss/mixins"; - -@import "../../../node_modules/bootstrap/scss/reboot"; -@import "../../../node_modules/bootstrap/scss/grid"; -@import "../../../node_modules/bootstrap/scss/buttons"; -@import "../../../node_modules/bootstrap/scss/transitions"; -@import "../../../node_modules/bootstrap/scss/dropdown"; -@import "../../../node_modules/bootstrap/scss/navbar"; -@import "../../../node_modules/bootstrap/scss/nav"; -@import "../../../node_modules/bootstrap/scss/tables"; -@import "../../../node_modules/bootstrap/scss/card"; -@import "../../../node_modules/bootstrap/scss/code"; -@import "../../../node_modules/bootstrap/scss/alert"; -@import "../../../node_modules/bootstrap/scss/modal"; -@import "../../../node_modules/bootstrap/scss/utilities"; diff --git a/_assets/sass/vendor/_bourbon.scss b/_assets/sass/vendor/_bourbon.scss deleted file mode 100644 index 7b679df018..0000000000 --- a/_assets/sass/vendor/_bourbon.scss +++ /dev/null @@ -1,2 +0,0 @@ -@import '../../node_modules/bourbon/core/bourbon'; - diff --git a/_assets/sass/vendor/_include-media.scss b/_assets/sass/vendor/_include-media.scss deleted file mode 100644 index 51a8d7f31f..0000000000 --- a/_assets/sass/vendor/_include-media.scss +++ /dev/null @@ -1,2 +0,0 @@ -@import '../../node_modules/include-media/dist/include-media'; - diff --git a/_config.yml b/_config.yml index 756837bca3..28619e1870 100755 --- a/_config.yml +++ b/_config.yml @@ -87,7 +87,8 @@ collections: port: 8080 -exclude: ['README.md', 'LICENSE', 'bower.json', 'Gemfile.lock', 'Gemfile', 'vendor', 'node_modules', '_assets', 'mix-manifest.json', 'webpack.mix.js', 'find-ungrouped-bidders.sh' ] +exclude: ['README.md', 'LICENSE', 'Gemfile.lock', 'Gemfile', 'vendor', 'find-ungrouped-bidders.sh' ] +include: ['node_modules'] keep_files: - assets/css/main-bundle.css diff --git a/_data/sidebar.yml b/_data/sidebar.yml index 9bc94921bd..3148ef7601 100644 --- a/_data/sidebar.yml +++ b/_data/sidebar.yml @@ -50,6 +50,14 @@ isSectionHeader: 0 subgroup: 0 +- sbSecId: 0 + title: Glossary + link: /overview/glossary.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 0 + - sbSecId: 0 title: Codes of Conduct link: @@ -122,20 +130,6 @@ isSectionHeader: 0 subgroup: 2 -- sbSecId: 0 - title: Prebid and MSPA - link: /features/mspa-usnat.html - isHeader: 0 - isSectionHeader: 0 - subgroup: 2 - -- sbSecId: 0 - title: Prebid and Quebec Privacy Support - link: /features/ac-quebec.html - isHeader: 0 - isSectionHeader: 0 - subgroup: 2 - #--------------Prebid.js--------------| - sbSecId: 1 @@ -264,7 +258,7 @@ subgroup: 1 - sbSecId: 1 - title: Using Prebid.js with AppNexus Publisher Ad Server + title: Using Prebid.js with Microsoft Monetize Ad Server link: /dev-docs/examples/use-prebid-with-appnexus-ad-server.html isHeader: 0 isSectionHeader: 0 @@ -372,6 +366,14 @@ sectionTitle: subgroup: 3 +- sbSecId: 1 + title: Internal API Reference + link: /dev-docs/internal-api-reference.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 3 + - sbSecId: 1 title: Ad Unit Reference link: /dev-docs/adunit-reference.html @@ -791,7 +793,7 @@ - sbSecId: 2 title: Ad Experience Controls - link: /prebid-mobile/modules/rendering/ios-sdk-customization-controls.html + link: /prebid-mobile/modules/rendering/combined-ad-experience-controls.html isHeader: 0 isSectionHeader: 0 sectionTitle: @@ -872,7 +874,7 @@ - sbSecId: 2 title: Ad Experience Controls - link: /prebid-mobile/modules/rendering/android-sdk-customization-controls.html + link: /prebid-mobile/modules/rendering/combined-ad-experience-controls.html isHeader: 0 isSectionHeader: 0 sectionTitle: @@ -886,6 +888,14 @@ sectionTitle: subgroup: 3 +- sbSecId: 2 + title: Prebid Plugin Renderer + link: /prebid-mobile/pbm-api/android/pbm-plugin-renderer.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 3 + #--------------Ad Ops--------------| - sbSecId: 3 @@ -1090,7 +1100,7 @@ subgroup: 2 - sbSecId: 3 - title: "AppNexus Publisher" + title: "Microsoft Monetize Publisher" link: isHeader: 0 isSectionHeader: 0 @@ -1330,6 +1340,14 @@ sectionTitle: subgroup: 0 +- sbSecId: 5 + title: 'PBS+Digital Out Of Home' + link: /prebid-server/use-cases/pbs-dooh.html + isHeader: 0 + isSectionHeader: 0 + sectionTitle: + subgroup: 0 + - sbSecId: 5 title: 'Hosting Your Own PBS' link: /prebid-server/hosting/pbs-hosting.html @@ -1714,7 +1732,7 @@ - sbSecId: 6 title: Video - link: /prebid-video/video-overview.html + link: /formats/video.html isHeader: 0 isSectionHeader: 0 sectionTitle: @@ -1783,12 +1801,34 @@ subgroup: 0 - sbSecId: 7 - title: Training Videos - link: /videos/ - isHeader: 0 + title: Privacy Resources + link: + isHeader: 1 + headerId: privacy isSectionHeader: 0 sectionTitle: - subgroup: 0 + subgroup: 1 + +- sbSecId: 7 + title: Prebid Privacy Overview + link: /support/privacy-resources.html + isHeader: 0 + isSectionHeader: 0 + subgroup: 1 + +- sbSecId: 7 + title: Prebid and MSPA + link: /features/mspa-usnat.html + isHeader: 0 + isSectionHeader: 0 + subgroup: 1 + +- sbSecId: 7 + title: Prebid and Quebec Privacy Support + link: /features/ac-quebec.html + isHeader: 0 + isSectionHeader: 0 + subgroup: 1 - sbSecId: 7 title: FAQs @@ -1843,15 +1883,6 @@ sectionTitle: subgroup: 0 -- sbSecId: 8 - title: Dr. Prebid Validation App - link: /prebid-mobile/dr-prebid.html - isHeader: 0 - isSectionHeader: 0 - sectionTitle: - subgroup: 0 - - #-------------- Prebid Identity --------------| - sbSecId: 9 diff --git a/_includes/code/mobile-sdk.html b/_includes/code/mobile-sdk.html new file mode 100644 index 0000000000..4aa50d54a6 --- /dev/null +++ b/_includes/code/mobile-sdk.html @@ -0,0 +1,17 @@ + +
+Bidder Code | +{{ page.biddercode }} | +Prebid.org Member | +{% if page.prebid_member == true %}yes{% else %}no{% endif %} | +||
---|---|---|---|---|---|
Prebid.js Adapter | +{% if page.pbjs == true %}yes{% else %}no{% endif %} | +Prebid Server Adapter | +{% if page.pbs == true %}yes{% else %}no{% endif %} | +||
Media Types | +{% unless page.media_types contains 'no-display' %}display{% if page.media_types contains 'video' %},{% endif %}{% endunless %}{% if page.media_types contains 'video' %} video{% endif %}{% if page.media_types != "no-display, native" and page.media_types contains 'native' %}, native{% endif %}{% if page.media_types == "no-display, native" %}native{% endif %} | +Multi Format Support | +{% if page.multiformat_supported %}{{page.multiformat_supported}}{% else %}check with bidder{% endif %} | +||
TCF-EU Support | +{% if page.tcfeu_supported == true %}yes{% else %}no{% endif %} | +IAB GVL ID | +{% if page.gvl_id %}{{page.gvl_id}}{% else %}check with bidder{% endif %} | +||
GPP Support | +{% if page.gpp_sids and page.gpp_sids != '' %}{{page.gpp_sids}}{% elsif page.gpp_supported == true and page.gpp_sids == nil %}some (check with bidder){% elsif page.gpp_supported == false and gpp_sids == nil %}None{% else %}check with bidder{% endif %} | +DSA Support | +{% if page.dsa_supported == true %}yes{% elsif page.dsa_supported == false %}no{% else %}check with bidder{% endif %} | +||
USP/CCPA Support | +{% if page.usp_supported == true %}yes{% elsif page.usp_supported == false %}no{% else %}check with bidder{% endif %} | +COPPA Support | +{% if page.coppa_supported == true %}yes{% elsif page.coppa_supported == false %}no{% else %}check with bidder{% endif %} | +||
Supply Chain Support | +{% if page.schain_supported == true %}yes{% elsif page.schain_supported == false %}no{% else %}check with bidder{% endif %} | +Demand Chain Support | +{% if page.dchain_supported == true %}yes{% elsif page.dchain_supported == false %}no{% else %}check with bidder{% endif %} | +||
Safeframes OK | +{% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %} | +Supports Deals | +{% if page.deals_supported == false %}no{% elsif page.deals_supported == true %}yes{% else %}check with bidder{% endif %} | +||
Floors Module Support | +{% if page.floors_supported == true %}yes{% elsif page.floors_supported == false %}no{% else %}check with bidder{% endif %} | +First Party Data Support | +{% if page.fpd_supported == true %}yes{% elsif page.fpd_supported == false %}no{% else %}check with bidder{% endif %} | +||
User IDs | +{% if page.userIds and page.userIds != '' %}{{page.userIds}}{% else %}none{% endif %} | +ORTB Blocking Support | +{% if page.ortb_blocking_supported == true %}yes{% elsif page.ortb_blocking_supported == false %}no{% elsif page.ortb_blocking_supported == 'partial' %}partial{% else %}check with bidder{% endif %} | +||
Privacy Sandbox | +{% if page.privacy_sandbox %}{{page.privacy_sandbox}}{% else %}check with bidder{% endif %} | + {% if page.pbs == true %} +Prebid Server App Support | +{% if page.pbs_app_supported == false %}no{% elsif page.pbs_app_supported == true %}yes{% else %}check with bidder{% endif %} | + {% else %} ++ | + {% endif %} + |
Bidder Code | -{{ page.biddercode }} | -Prebid.org Member | -{% if page.prebid_member == true %}yes{% else %}no{% endif %} | -
---|---|---|---|
Media Types | -{% unless page.media_types contains 'no-display' %}display{% if page.media_types contains 'video' %},{% endif %}{% endunless %}{% if page.media_types contains 'video' %} video{% endif %}{% if page.media_types != "no-display, native" and page.media_types contains 'native' %}, native{% endif %}{% if page.media_types == "no-display, native" %}native{% endif %} | -TCF-EU Support | -{% if page.tcfeu_supported == true %}yes{% else %}no{% endif %} | -
User IDs | -{% if page.userIds and page.userIds != '' %}{{page.userIds}}{% else %}none{% endif %} | -USP/CCPA Support | -{% if page.usp_supported == true %}yes{% elsif page.usp_supported == false %}no{% else %}check with bidder{% endif %} | -
Supply Chain Support | -{% if page.schain_supported == true %}yes{% elsif page.schain_supported == false %}no{% else %}check with bidder{% endif %} | -COPPA Support | -{% if page.coppa_supported == true %}yes{% elsif page.coppa_supported == false %}no{% else %}check with bidder{% endif %} | -
Demand Chain Support | -{% if page.dchain_supported == true %}yes{% elsif page.dchain_supported == false %}no{% else %}check with bidder{% endif %} | -GPP Support | -{% if page.gpp_sids and page.gpp_sids != '' %}{{page.gpp_sids}}{% elsif page.gpp_supported == true and page.gpp_sids == nil %}some (check with bidder){% elsif page.gpp_supported == false and gpp_sids == nil %}None{% else %}check with bidder{% endif %} | -
Supports Deals | -{% if page.deals_supported == false %}no{% elsif page.deals_supported == true %}yes{% else %}check with bidder{% endif %} | -Prebid.js Adapter | -{% if page.pbjs == true %}yes{% else %}no{% endif %} | -
IAB GVL ID | -{% if page.gvl_id %}{{page.gvl_id}}{% else %}check with bidder{% endif %} | -Prebid Server Adapter | -{% if page.pbs == true %}yes{% else %}no{% endif %} | -
Floors Module Support | -{% if page.floors_supported == true %}yes{% elsif page.floors_supported == false %}no{% else %}check with bidder{% endif %} | -First Party Data Support | -{% if page.fpd_supported == true %}yes{% elsif page.fpd_supported == false %}no{% else %}check with bidder{% endif %} | -
Multi Format Support | -{% if page.multiformat_supported %}{{page.multiformat_supported}}{% else %}check with bidder{% endif %} | -ORTB Blocking Support | -{% if page.ortb_blocking_supported == true %}yes{% elsif page.ortb_blocking_supported == false %}no{% elsif page.ortb_blocking_supported == 'partial' %}partial{% else %}check with bidder{% endif %} | -
Safeframes OK | -{% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %} | -- | - |
Back to Internal API Reference
+ +