Document the conditions under which index.html is cretaed at the root.

JuliaDocs#2127
fsaad · May 24, 2023 · b407719 · b407719
1 parent 233a782
commit b407719
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/src/deploydocs.jl b/src/deploydocs.jl
@@ -52,6 +52,14 @@ The deployment procedure consists of the following steps:
   push the `repo`. Note that any `.gitignore` files in the `target` directory
   affect which files will be committed to `branch`.
 
+!!! note
+    The `index.html` file at the root will not be created or overwritten
+    during the deployment process if
+    (1) such a file already exists; and
+    (2) it does not begin with the HTML comment
+    `<!--This file is automatically generated by Documenter.jl-->`.
+!!!
+
 # Required keyword arguments
 
 **`repo`** is the remote repository where generated HTML content should be pushed to. Do not