Skip to content

Commit

Permalink
Merge pull request #76 from pbredenberg/pb/chore-standardization-upgr…
Browse files Browse the repository at this point in the history
…ades

chore: upgrade standardization and configure markdownlint
  • Loading branch information
onebytegone authored Sep 10, 2021
2 parents 263b1f4 + 99006b8 commit 8b1a082
Show file tree
Hide file tree
Showing 5 changed files with 425 additions and 261 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"extends": "./node_modules/@silvermine/standardization/.markdownlint.json"
}
17 changes: 15 additions & 2 deletions Gruntfile.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
'use strict';

var path = require('path'),
getCodeVersion = require('silvermine-serverless-utils/src/get-code-version');
getCodeVersion = require('silvermine-serverless-utils/src/get-code-version'),
markdownlint = require('markdownlint');

const sass = require('node-sass');

Expand Down Expand Up @@ -137,6 +138,17 @@ module.exports = function(grunt) {
},
},

markdownlint: {
all: {
// Adjust `src` depending on how many files need to be linted:
src: [ 'README.md' ],
options: {
// eslint-disable-next-line no-sync
config: markdownlint.readConfigSync('.markdownlint.json'),
},
},
},

});

grunt.loadNpmTasks('grunt-contrib-uglify');
Expand All @@ -147,8 +159,9 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-clean');
grunt.loadNpmTasks('grunt-sass');
grunt.loadNpmTasks('grunt-stylelint');
grunt.loadNpmTasks('grunt-markdownlint');

grunt.registerTask('standards', [ 'eslint', 'stylelint' ]);
grunt.registerTask('standards', [ 'eslint', 'stylelint', 'markdownlint' ]);
grunt.registerTask('build-js', [ 'browserify', 'uglify' ]);
grunt.registerTask('build-css', [ 'sass', 'postcss' ]);
grunt.registerTask('build', [ 'build-js', 'build-css' ]);
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,14 +31,14 @@ for `videojs` at `window.videojs`).
There is an example of this in
[`docs/demo/index.html`](./docs/demo/index.html).

##### From local file:
##### From local file

```js
<script src="./path/to/video.min.js"></script>
<script src="./path/to/silvermine-videojs-quality-selector.min.js"></script>
```

##### From [`unpkg`](https://unpkg.com/@silvermine/videojs-quality-selector/):
##### From [`unpkg`](https://unpkg.com/@silvermine/videojs-quality-selector/)

```js
<link href="https://unpkg.com/@silvermine/videojs-quality-selector/dist/css/quality-selector.css" rel="stylesheet">
Expand All @@ -50,7 +50,7 @@ There is an example of this in

When using NPM/Browserify, first install the plugin.

```
```bash
npm install --save @silvermine/videojs-quality-selector
```

Expand Down Expand Up @@ -113,13 +113,13 @@ player.src([
There are at least two ways to add the quality selector control to the player's control
bar. The first is directly adding it via `addChild`. For example:

```
```js
player.controlBar.addChild('QualitySelector');
```

The second option is to add the control via the player's options, for instance:

```
```js
var options, player;

options = {
Expand Down
Loading

0 comments on commit 8b1a082

Please sign in to comment.