Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

[Typst Universe] Documentation field #2860

Open
Labels
@cAttte

Description

Description

i propose that typst.toml support a documentation field, containing a URL, and that this link be displayed in the sidebar of the package's Universe page, akin to some other great package repositories:

crates.io hex.pm pub.dev potentially, typst.app/universe*

*(not a fan of "PDF" as the link content; just not sure what else could go there. "Manual", "Reference"...?)

notably, all three repositories listed provide documentation hosting (which is what these links point to). so i guess this addition would be a nice transitional measure until the far future where HTML export is stable and we get to have auto-generated Universe-hosted package docs :D (if there are plans to do that)

Use Case

every package needs documentation, so it's pretty weird that a link to it isn't formalized the same way the Repository link is. instead, one has to scan for the link in the readme, which the author may decide to place absolutely anywhere, or nowhere at all—sometimes choosing to use the readme itself as a documentation page, which isn't immediately apparent (though i'm not sure how much this feature would help here).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

        AltStyle によって変換されたページ (->オリジナル) /