Skip to content

add a note about readme files #122

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexvoss merged 1 commit into from
May 12, 2026
Merged

add a note about readme files #122

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/authoring/markdown.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,15 @@ lists, links, blockquotes, and inline formatting (e.g., bold and italics).
[differences]: https://python-markdown.github.io/#differences
[start a new list]: https://spec.commonmark.org/0.31.2/#lists

!!! warning "README files"

`README.md` files in the `docs_dir` are converted to `index.html` just
as in MkDocs. However, if both `README.md` and `index.md` are present
in a directory the behavior is currently undefined, so it is better
to avoid having both. We have a [backlog item][bl_readme] to review this.

[bl_readme]: https://github.com/zensical/backlog/issues/135

Both Python Markdown itself and the [Python Markdown Extensions] that Zensical
also supports provide extensions to the core Markdown language to cater for the
needs of technical writers who want to produce clear, compelling, and visually
Expand Down