Add man page #4461
Add man page #4461
Conversation
There was a problem hiding this comment.
This looks super useful!
Should we as part of this cut the previous attempt at "man pages" like https://github.com/vgteam/vg/blob/36c322a4e0e6ad2939aed4f01c97bf6788905da3/doc/asciidoc/man/vg-test.adoc where we had individual hand-maintained AsciiDoc format files that we never finished?
Is this meant to ever get you a "real" man page (i.e. something you can read with man in its weird troff format)? It might be good to have a step that calls something like:
- https://github.com/sunaku/md2man
- https://rtomayko.github.io/ronn/ronn.1.html
- https://github.com/remarkjs/remark-man?tab=readme-ov-file#remark-man
Otherwise it's a little confusing to say that this is a "man page".
doc/README.md
Outdated
|
|
||
| ```sh | ||
| python3 vgmanmd.py > man.md | ||
| ``` | ||
|
|
||
| Then copy the markdown content to a wiki page, for example, or move the markdown page to somewhere in the vg repo? |
There was a problem hiding this comment.
There's a checkout of the wiki as a submodule, so this maybe should involve writing to wiki/vg-manpage.md and committing and pushing.
This could also become a Makefile target e.g. make manpage.
|
Here's something on writing Markdown that Pandoc knows how to translate for |
|
@xchang1 The numbers aren't pages of the man page but section numbers of the manual. I think vg should indeed be section 1. |
Changelog Entry
Description
@jmonlong and I made a man page for vg.
It can be automatically generated to stay up to date with changes to the CLI