Skip to content

Render Markdown files linked from Readme #904

Description

@sijow

Description

Currently if a package README.md links to a local Markdown file, that file is served as plain text. It would be nice to render it like the Readme itself.

Use Case

For example version 0.5.0 of the bytefield package has a Readme with a local link to CHANGELOG.md. On the Universe this is translated to a raw GitHub link: https://raw.githubusercontent.com/typst/packages/main/packages/preview/bytefield/0.0.5/CHANGELOG.md which serves plain text.

A simple fix would be to translate such links to non-raw GitHub URLs like https://github.com/typst/packages/blob/main/packages/preview/bytefield/0.0.5/CHANGELOG.md

Probably even nicer would be to serve a rendered file on the Universe itself, with the same styling as the Readme.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working.universeAbout Typst Universe

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions