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

First batch of markdownlint fixes #4620

Merged
merged 11 commits into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 20 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@ This repository contains the source files for the Prebid.js documentation site a

Please see the sections below for more information:

+ [Contributing](#contributing)
+ [License](#license)
+ [Prerequisites](#prerequisites)
+ [Running Jekyll Locally](#running-jekyll-locally)
+ [Building Assets](#building-assets)
+ [The Downloads Page](#the-downloads-page)
+ [Thanks](#thanks)
* [Contributing](#contributing)
* [License](#license)
* [Prerequisites](#prerequisites)
* [Running Jekyll Locally](#running-jekyll-locally)
* [Building Assets](#building-assets)
* [The Downloads Page](#the-downloads-page)
* [Thanks](#thanks)

<a name="contributing" />
<a name="contributing"></a>

## Contributing

Expand All @@ -20,16 +20,16 @@ For smaller changes, such as fixing a typo or adding a new section to an existin

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:

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

<a name="license" />
<a name="license"></a>

## License

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

<a name="prerequisites" />
<a name="prerequisites"></a>

## Prerequisites

Expand All @@ -45,7 +45,7 @@ For CSS, the site uses Laravel Mix to build CSS from Sass (scss-flavored) source
1. `npm ci` to install packages for building assets
1. build assets as described below

<a name="running-jekyll-locally" />
<a name="running-jekyll-locally"></a>

## Running Jekyll Locally

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

```bash
$ JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
JEKYLL_ENV=production bundle exec jekyll serve --watch --incremental
```


You should see output that looks something like this:

```
```bash
Configuration file: /Users/me/git/prebid.github.io/_config.yml
Source: /Users/me/git/prebid.github.io
Destination: /Users/me/git/prebid.github.io/_site
Expand All @@ -77,13 +76,13 @@ Configuration file: /Users/me/git/prebid.github.io/_config.yml

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

<a name="building-assets"/>
<a name="building-assets"></a>

## Building Assets

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

## The Downloads Page

Expand All @@ -98,7 +97,7 @@ The Downloads page is generated from [the Markdown bidder adapter docs](https://

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).

<a name="thanks" />
<a name="thanks"></a>

## Thanks

Expand Down
18 changes: 9 additions & 9 deletions _assets/sass/abstracts/_breakpoints.scss
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
// Breakpoint Declarations
//
// Responsive breakpoint declarations
// Breakpoints are matched in Responsive VC Design Options Plugin
// http://actian/wp-admin/admin.php?page=bb_edo_all_devices
// Breakpoints are matched in Responsive VC Design Options Plugin
// http://actian/wp-admin/admin.php?page=bb_edo_all_devices
//
// Markup:
// 'phone-xs': 320px,
// 'phone-sm': 480px,
// 'phone': 767px, // Page Builder Default
// 'tablet': 960px, // Page Builder Default
// 'desktop-sm': 1200px,
// 'desktop': 1980px,
// Markup:
// 'phone-xs': 320px,
// 'phone-sm': 480px,
// 'phone': 767px, // Page Builder Default
// 'tablet': 960px, // Page Builder Default
// 'desktop-sm': 1200px,
// 'desktop': 1980px,
//
// Styleguide Layout.Breakpoints

Expand Down
2 changes: 1 addition & 1 deletion _assets/sass/abstracts/_mixins.scss
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@
@mixin ie10-and-up {
@media all and (-ms-high-contrast: none), (-ms-high-contrast: active) {
@content
}
}
}

// linear-gradient
Expand Down
12 changes: 6 additions & 6 deletions _assets/sass/pages/_404.scss
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
.error404 {
width:100%;
height: 100%;
text-align: center;
width:100%;
height: 100%;
text-align: center;
}

.error404 h1 {
color: #FF0000;
font-size: 60px;
font-weight: bold;
color: #FF0000;
font-size: 60px;
font-weight: bold;
}


12 changes: 4 additions & 8 deletions _includes/dev-docs/native-image-asset-sizes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@ There are two methods for defining sizes for image-like assets (`image` and `ico

Using `mediaTypes.native.image.sizes` (or `mediaTypes.native.icon.sizes` for icons):

{% highlight js %}

```javascript
mediaTypes: {
native: {
image: {
Expand All @@ -12,13 +11,11 @@ mediaTypes: {
}
}
}

{% endhighlight %}
```

Using `mediaTypes.native.image.aspect_ratios` (or `mediaTypes.native.icon.aspect_ratios` for icons):

{% highlight js %}

```javascript
mediaTypes: {
native: {
image: {
Expand All @@ -32,5 +29,4 @@ mediaTypes: {
}
}
}

{% endhighlight %}
```
6 changes: 3 additions & 3 deletions _layouts/analytics.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@

<div class="row ">

<div class="col-lg-3 sidebar" id="sidebar">
<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
{% include left_nav.html %}
</div>
</div>

</div>
</div>

<div class="col-lg-9">
<div class="pb-content" markdown="1">
Expand Down
8 changes: 4 additions & 4 deletions _layouts/bidder.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@

<div class="row ">

<div class="col-lg-3 sidebar" id="sidebar">
<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
{% include left_nav.html %}
</div>
</div>

</div>
</div>

<div class="col-lg-9">
<div class="pb-content" markdown="1">
Expand Down Expand Up @@ -108,7 +108,7 @@ <h3>Features</h3>
<th class="pbTh">Safeframes OK</th>
<td class="pbTd">{% if page.safeframes_ok == false %}no{% elsif page.safeframes_ok == true %}yes{% else %}check with bidder{% endif %}</td>
<th class="pbTh"></th>
<td class="pbTd"></td>
<td class="pbTd"></td>
</tr>
</table>

Expand Down
10 changes: 5 additions & 5 deletions _layouts/example.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@
<div class="row">

<!-- Left nav -->
<div class="col-lg-3 sidebar" id="sidebar">
<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
{% include left_nav.html %}
</div>
</div>

</div>
</div>

<!-- Main content -->
<div class="col-lg-9">
Expand Down Expand Up @@ -51,10 +51,10 @@ <h4>About this example:</h4>
</div>
</div>

<p></p>
<p></p>
<p>
In the JSFiddle example below:
<ul><li>Click <b>Result</b> to see the example output.</li>
<ul><li>Click <b>Result</b> to see the example output.</li>
<li>Click <b>Edit in JSFiddle</b> to open the example in the JSFiddle editor in a new tab.</li></ul>
</p>

Expand Down
6 changes: 3 additions & 3 deletions _layouts/userid.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,18 @@

<div class="row ">

<div class="col-lg-3 sidebar" id="sidebar">
<div class="col-lg-3 sidebar" id="sidebar">

<div>
<button class="navbar-toggler d-lg-none" type="button" data-toggle="collapse" data-target="#sidebarContent" aria-controls="sidebarContent" aria-expanded="false" aria-label="Toggle Sidebar navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse d-lg-block" id="sidebarContent">
{% include left_nav.html %}
{% include left_nav.html %}
</div>
</div>

</div>
</div>

<div class="col-lg-9">
<div class="pb-content" markdown="1">
Expand Down
2 changes: 1 addition & 1 deletion about.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ sidebarType: 0
<style>

p {
font-size: 18px;
font-size: 18px;
}

</style>
Expand Down
Loading