The following basenames are considered "index files":
Those basenames have the following magic properties:
- the default output file name for an index file in HTML output is either:
index.htmlwhen in the project toplevel directory. E.g.
index.html. Note that GitHub and many other static website hosts then automatically hide the
index.htmlpart from the URL, so that your
http://example.comwill be accessible simply under
- the name of the subdirectory in which it is located when not in the project toplevel directory. E.g.
mysubdir.htmlPreviously, we had placed the output in
mysubdir/index.html, but this is not as nice as it makes GitHub pages produce URLs with a trailing slash as
mysubdir/, which is ugly, see also: stackoverflow.com/questions/5948659/when-should-i-use-a-trailing-slash-in-my-url
- the default toplevel header ID of an index files is derived from the parent directory basename rather than from the source file basename