Merge pull request #3 from rubocop/chore

Add necessary files

Author: ydah

.codespellignore

@@ -0,0 +1 @@
+rouge

.gitattributes

@@ -0,0 +1 @@
+*.adoc whitespace=trailing-space,tab-in-indent

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'weekly'

.github/workflows/codespell.yml

@@ -0,0 +1,19 @@
+name: CodeSpell
+on:
+  - pull_request
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+jobs:
+  codespell:
+    name: CodeSpell
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: CodeSpell
+        uses: codespell-project/actions-codespell@master
+        with:
+          check_filenames: true
+          check_hidden: true
+          ignore_words_file: .codespellignore
+          exclude_file: docs/index.html

.github/workflows/deploy.yml

@@ -0,0 +1,38 @@
+name: Deploy documentation to GitHub Pages
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    if: ${{ github.repository == 'rubocop/capybara-style-guide' && !startsWith(github.event_name, 'pull') }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.4"
+          bundler-cache: true
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+      - name: AsciiDoc to HTML
+        run: bundle exec asciidoctor -a toc="left" -a toclevels=2 README.adoc -o docs/index.html
+      - uses: actions/upload-pages-artifact@v3
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,3 @@
+README.html
+README.pdf
+Gemfile.lock

.nojekyll

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem 'asciidoctor'
+gem 'rouge', '3.3.0'

Gemfile

@@ -48,7 +48,7 @@ gem install rouge
 
 == A Living Document
 
-This guide is work in progress - trying to fill in the arguments by which the rubocop-capbyara cops were written so that users can undestand the tradeoffs on different approaches (whether to configure, enable or disable different cops)  and understand where it's a question of consistency and/or style, or are there other issues at play.
+This guide is work in progress - trying to fill in the arguments by which the rubocop-capbyara cops were written so that users can understand the tradeoffs on different approaches (whether to configure, enable or disable different cops)  and understand where it's a question of consistency and/or style, or are there other issues at play.
 
 == Using Capybara