Skip to content
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.

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

Render meta.longDescription from markdown #525

Closed
fricklerhandwerk opened this issue Aug 29, 2022 · 4 comments · Fixed by #539
Closed

Render meta.longDescription from markdown #525

fricklerhandwerk opened this issue Aug 29, 2022 · 4 comments · Fixed by #539
Assignees

Comments

@fricklerhandwerk
Copy link
Contributor

The description of some packages contains markdown, which is currently lost in presentation.

Screenshot 2022-08-29 at 12 32 02

Source: https://github.com/NixOS/nixpkgs/blob/nixos-22.05/pkgs/tools/misc/tmux/default.nix#L69

@ncfavier ncfavier self-assigned this Aug 29, 2022
@ncfavier
Copy link
Member

ncfavier commented Aug 29, 2022

While I think this is reasonable, I can't find any authority on what the format of longDescription is supposed to be (though the convention seems to be markdown). I think this should at least go with a PR in nixpkgs to document in the manual that longDescription should be markdown, to see what people think.

We should also implement markdown rendering for options, following NixOS/nixpkgs#176146. Currently this is not an issue because we delegate the markdown rendering to nixpkgs for nixos options and flake authors have not started using mdDoc/literalMD yet, but it will be at some point.

@deemp
Copy link
Contributor

deemp commented Jan 31, 2023

Hi, @ncfavier . In our flake nix-vscode-extensions, there's packages.x86_64-linux.vscodiumWithExtensions.meta.longDescription. However, this description is not rendered on search.nixos

image

How can we have the longDescription rendered as Markdown?

@ncfavier
Copy link
Member

#607

@deemp
Copy link
Contributor

deemp commented Jan 31, 2023

Okay, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants