Add pre-commit (#2)

Author: giswqs

.github/workflows/docs.yml

@@ -22,7 +22,7 @@ jobs:
           codespell --skip=".*,.git/*,*.csv,*.geojson,*.json,*.js,*.html,*cff,*.pdf" --ignore-words-list="aci,acount,acounts,fallow,hart,hist,nd,ned,ois,wqs"
       - name: Install dependencies
         run: pip install mkdocs-material mkdocstrings mkdocs-git-revision-date-plugin mkdocs-jupyter mkdocs-pdf-export-plugin ipykernel
-      - name: depoly
+      - name: deploy
         run: mkdocs gh-deploy --force
         env:
           RUN_GITHUB_ACTION: ${{ secrets.RUN_GITHUB_ACTION }}

.pre-commit-config.yaml

@@ -0,0 +1,32 @@
+repos:
+    - repo: https://github.com/pre-commit/pre-commit-hooks
+      rev: v5.0.0
+      hooks:
+          - id: check-toml
+          - id: check-yaml
+          - id: end-of-file-fixer
+            types: [python]
+          - id: trailing-whitespace
+          - id: requirements-txt-fixer
+          - id: check-added-large-files
+            args: ["--maxkb=500"]
+
+    - repo: https://github.com/psf/black
+      rev: 25.1.0
+      hooks:
+          - id: black-jupyter
+
+    - repo: https://github.com/codespell-project/codespell
+      rev: v2.4.1
+      hooks:
+          - id: codespell
+            args:
+                [
+                    "--ignore-words-list=aci,acount,acounts,fallow,ges,hart,hist,nd,ned,ois,wqs,watermask,tre,mape",
+                    "--skip=*.csv,*.geojson,*.json,*.yml*.js,*.html,*cff,*.pdf",
+                ]
+
+    - repo: https://github.com/kynan/nbstripout
+      rev: 0.8.1
+      hooks:
+          - id: nbstripout

README.md

@@ -9,7 +9,7 @@ Steps to use this template:
 - Add/remove dependencies in `requirements.txt` if need.
 - Add folders (e.g., `chapter_01`) and files (e.g., `intro.ipynb`, `index.md`) to the `docs` folder.
 - Open `mkdocs.yml` and make several changes, including `site_name`, `site_url`, `repo_url`, and `nav`. If you don't want the notebooks to be executed when building the website, set `execute: False` under `plugins`.
-- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed. 
+- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed.
 - Commit the changes using Git and push changes to GitHub.
-- Enable GitHub Pages through GitHub Settings - Pages. 
-- Check out the website at https://username.github.io/repo-name. 
+- Enable GitHub Pages through GitHub Settings - Pages.
+- Check out the website at https://username.github.io/repo-name.

docs/chapter_01/basemaps.ipynb

@@ -16,7 +16,7 @@
    "outputs": [],
    "source": [
     "m = leafmap.Map()\n",
-    "m.add_basemap('HYBRID')\n",
+    "m.add_basemap(\"HYBRID\")\n",
     "m"
    ]
   }
@@ -41,8 +41,7 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.9.9"
-  },
-  "orig_nbformat": 4
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

docs/chapter_01/intro.ipynb

@@ -40,8 +40,7 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.9.9"
-  },
-  "orig_nbformat": 4
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

docs/chapter_02/colorbar.ipynb

@@ -33,7 +33,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "colors = ['006633', 'E5FFCC', '662A00', 'D8D8D8', 'F5F5F5']\n",
+    "colors = [\"006633\", \"E5FFCC\", \"662A00\", \"D8D8D8\", \"F5F5F5\"]\n",
     "vmin = 0\n",
     "vmax = 4000\n",
     "\n",
@@ -63,8 +63,7 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.9.9"
-  },
-  "orig_nbformat": 4
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

docs/chapter_02/heatmap.ipynb

@@ -28,7 +28,7 @@
     "m.add_heatmap(\n",
     "    filepath,\n",
     "    latitude=\"latitude\",\n",
-    "    longitude='longitude',\n",
+    "    longitude=\"longitude\",\n",
     "    value=\"pop_max\",\n",
     "    name=\"Heat map\",\n",
     "    radius=20,\n",
@@ -57,8 +57,7 @@
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
    "version": "3.9.9"
-  },
-  "orig_nbformat": 4
+  }
  },
  "nbformat": 4,
  "nbformat_minor": 2

docs/index.md

@@ -9,7 +9,7 @@ Steps to use this template:
 - Add/remove dependencies in `requirements.txt` if need.
 - Add folders (e.g., `chapter_01`) and files (e.g., `intro.ipynb`, `index.md`) to the `docs` folder.
 - Open `mkdocs.yml` and make several changes, including `site_name`, `site_url`, `repo_url`, and `nav`. If you don't want the notebooks to be executed when building the website, set `execute: False` under `plugins`.
-- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed. 
+- Customize the issue template (`.github/ISSUE_TEMPLATE/config.yml`) if needed.
 - Commit the changes using Git and push changes to GitHub.
-- Enable GitHub Pages through GitHub Settings - Pages. 
-- Check out the website at https://username.github.io/repo-name. 
+- Enable GitHub Pages through GitHub Settings - Pages.
+- Check out the website at https://username.github.io/repo-name.

docs/template.ipynb

@@ -3,7 +3,7 @@
   {
    "attachments": {},
    "cell_type": "markdown",
-   "id": "45382bbe",
+   "id": "0",
    "metadata": {},
    "source": [
     "[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/giswqs/mkdocs-template/blob/master/docs/template.ipynb)\n",
@@ -13,7 +13,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "31f7cf26-effb-48c2-a15c-dfa43e34c765",
+   "id": "1",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -23,7 +23,7 @@
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "d8398916-b4f5-4c9d-a1db-f8abb800bfeb",
+   "id": "2",
    "metadata": {},
    "outputs": [],
    "source": []

mkdocs.yml

@@ -5,7 +5,7 @@ site_url: https://giswqs.github.io/mkdocs-template
 
 repo_url: https://github.com/giswqs/mkdocs-template
 
-copyright: "Copyright © 2022 - 2023 Qiusheng Wu"
+copyright: "Copyright © 2022 - 2025 Qiusheng Wu"
 
 theme:
   palette:
@@ -49,10 +49,10 @@ markdown_extensions:
   - toc:
       permalink: true
 
-extra:
-  analytics:
-    provider: google
-    property: G-XXX
+# extra:
+#   analytics:
+#     provider: google
+#     property: G-XXX
 
 nav:
   - Home: index.md
@@ -64,6 +64,5 @@ nav:
   - Chapter 2:
       - chapter_02/colorbar.ipynb
       - chapter_02/heatmap.ipynb
-  - Blog: https://blog.gishub.org
   - YouTube Channel: https://youtube.com/@giswqs
   - Report Issues: https://github.com/giswqs/mkdocs-template/issues