Add index-to-README

.pre-commit-hooks.yaml

@@ -41,3 +41,8 @@
   entry: pre_commit_hooks/main.sh disable-sidebar_label
   language: script
   types: [markdown]
+- id: index-to-README
+  name: Rename index.md to README.md
+  entry: pre_commit_hooks/main.sh index-to-README
+  language: script
+  types: [markdown]

pre_commit_hooks/index-to-README.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+check() {
+    local ret=0
+
+    # README.md is the preferred naming to have better integration with GitHub
+    if [[ "$(basename "$1")" == "index.md" ]]
+    then
+        echo "$1: index.md should be named to README.md." >&2
+        ret=1
+        if ! $DRY_RUN
+        then
+            mv "$1" "$(dirname "$1")/README.md"
+        fi
+    fi
+
+    return $ret
+}