diff --git a/.markdownlint.json b/.markdownlint.json new file mode 100644 index 0000000..703ffa1 --- /dev/null +++ b/.markdownlint.json @@ -0,0 +1,3 @@ +{ + "extends": "./node_modules/@silvermine/standardization/.markdownlint.json" +} diff --git a/Gruntfile.js b/Gruntfile.js index f991a28..482766e 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -1,5 +1,7 @@ 'use strict'; +var markdownlint = require('markdownlint'); + module.exports = function(grunt) { var config; @@ -18,11 +20,22 @@ module.exports = function(grunt) { target: config.js.all, }, + markdownlint: { + all: { + src: [ 'README.md' ], + options: { + // eslint-disable-next-line no-sync + config: markdownlint.readConfigSync('.markdownlint.json'), + }, + }, + }, + }); grunt.loadNpmTasks('grunt-eslint'); + grunt.loadNpmTasks('grunt-markdownlint'); - grunt.registerTask('standards', [ 'eslint' ]); + grunt.registerTask('standards', [ 'eslint', 'markdownlint' ]); grunt.registerTask('default', [ 'standards' ]); }; diff --git a/README.md b/README.md index c0ef8ce..0c98109 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ NOTE: at this time, it is assumed that the topic is in the same account and region as the Lambda function itself. That can be changed in the future if needed - feel free to open an issue, and preferably submit a pull request. -``` +```yaml functions: doSomething: name: ${self:service}-${self:provider.stage}-doSomething