Merge pull request #59 from yarikoptic/enh-codespell

Add codespell support (config, workflow to detect/not fix) and make it fix few typos

Author: timvink

.github/workflows/codespell.yml

@@ -0,0 +1,23 @@
+# Codespell configuration is within .codespellrc
+---
+name: Codespell
+
+on:
+ push:
+ branches: [master]
+ pull_request:
+ branches: [master]
+
+permissions:
+ contents: read
+
+jobs:
+ codespell:
+ name: Check for spelling errors
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v4
+ - name: Codespell
+ uses: codespell-project/actions-codespell@v2

docs/howto/project_structure.md

@@ -30,7 +30,7 @@ This works because the [option](../options.md) `search_page_directory` defaults
 
 ## Re-using tables across markdown files
 
-If you want to re-use tables in multiple markdown files, you'll want to store them in a central directory, like `docs/assets/tables`. 
+If you want to reuse tables in multiple markdown files, you'll want to store them in a central directory, like `docs/assets/tables`. 
 That way, if you restructure your navigation, the links to the tables won't break either.
 It's also great if you generate tables because the output directory will be the same.
 
@@ -57,7 +57,7 @@ In `page.md`, to read `basic_table.csv`, you can choose to use:
 
 ## A central table directory combined with same-directory tables
 
-If you have some central tables that you want to re-use, and some tables that are specific to a page, you could use the following project structure:
+If you have some central tables that you want to reuse, and some tables that are specific to a page, you could use the following project structure:
 
 ```nohighlight
 .

mkdocs_table_reader_plugin/plugin.py

@@ -126,9 +126,9 @@ def on_page_markdown(self, markdown, page, config, files, **kwargs):
  markdown_table = fix_indentation(leading_spaces, markdown_table)
 
  # Insert markdown table
- # By replacing only the first occurance of the regex pattern
+ # By replacing only the first occurrence of the regex pattern
  # You might insert multiple CSVs with a single reader like read_csv
- # Because of the replacement, the next occurance will be the first match for .sub() again.
+ # Because of the replacement, the next occurrence will be the first match for .sub() again.
  # This is always why when allow_missing_files=True we replaced the input tag.
  markdown = tag_pattern.sub(markdown_table, markdown, count=1)