chore: Add remark-lint + CI (#977)

* chore: Add initial remark-lint setup

Author: nschonni

.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+on:
+  push:
+    branches-ignore:
+      - "dependabot/**"
+    paths:
+      - "package*.json"
+      - "**/*.md"
+      - ".github/workflows/ci.yml"
+
+  pull_request:
+    paths:
+      - "package*.json"
+      - "**/*.md"
+      - ".github/workflows/ci.yml"
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2.1.5
+
+      - name: Install npm dependencies
+        run: npm ci
+
+      - name: Test
+        run: npm test

.gitignore

@@ -0,0 +1 @@
+node_modules/

.remarkrc

@@ -0,0 +1,27 @@
+{
+  "plugins": [
+    "remark-gfm",
+    "remark-preset-lint-node",
+    ["remark-lint-fenced-code-flag", false],
+    ["remark-lint-final-definition", false],
+    ["remark-lint-final-newline", false],
+    ["remark-lint-first-heading-level", false],
+    ["remark-lint-hard-break-spaces", false],
+    ["remark-lint-heading-style", false],
+    ["remark-lint-list-item-bullet-indent", false],
+    ["remark-lint-list-item-indent", false],
+    ["remark-lint-maximum-line-length", false],
+    ["remark-lint-no-consecutive-blank-lines", false],
+    ["remark-lint-no-heading-content-indent", false],
+    ["remark-lint-no-literal-urls", false],
+    ["remark-lint-no-multiple-toplevel-headings", false],
+    ["remark-lint-no-shortcut-reference-link", false],
+    ["remark-lint-no-trailing-spaces", false],
+    ["remark-lint-no-undefined-references", false],
+    ["remark-lint-no-unused-definitions", false],
+    ["remark-lint-prohibited-strings", false],
+    ["remark-lint-strong-marker", false],
+    ["remark-lint-table-cell-padding", false],
+    ["remark-lint-unordered-list-marker-style", false]
+  ]
+}