Visitar URL original
Display README.lhs if there is no README.md · Issue #1436 · haskell/hackage-server · GitHub
Skip to content

Display README.lhs if there is no README.md #1436

Open

Description

@sellout

markdown-unlit treats Markdown files as Literate Haskell, and it recommends using a README.lhs file symlinked from README.md. The README.lhs will already be included in the package due to it being used in a test suite, while the README.md would need to additionally be added via an extra-files entry in the Cabal file.

It would be nice if Hackage rendered the README.lhs as Markdown if no README.md file is included in the package.

The one issue with this is if the README.lhs is in LaTeX or some other format. However, GitHub doesn’t support LaTeX as a README format (and I think the same is true of other software forges), so I think this pattern is unlikely.

This is different from other README requests like #574 and #890 in that it doesn’t require any new rendering, just falling back to a different file name.

Unfortunately, Hackage doesn’t track test-suite dependencies, so it’s hard to tell how widespread this pattern is, but I know at least one package that has a README.lhs without a README.md in the Cabal package that would benefit from this (and I would like to do the same with my own packages).

Activity

  1. added a commit that references this issue on Oct 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions