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

man pages? #1108

Open
znd4 opened this issue Apr 7, 2024 · 1 comment
Open

man pages? #1108

znd4 opened this issue Apr 7, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@znd4
Copy link

znd4 commented Apr 7, 2024

Obviously this would be a lot of work, so this isn't a demand, but I'm curious if you'd be open to someone adding a manpage (e.g. man 5 devenv.nix) for devenv.nix? I'm not sure if there's a best practice to have a man 5 devenv.yaml, but I'm assuming that people will be able to mentally translate without too much work.

I don't know if building a man file will be as simple as pandoc ... existing_docs.md, but I'd love to try to get something like that working in package.nix

@znd4 znd4 added the enhancement New feature or request label Apr 7, 2024
@domenkozar
Copy link
Member

It shouldn't be that much work to do, see https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/default.nix#L199

@sandydoo sandydoo added the documentation Improvements or additions to documentation label Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants