Manpage renderer
Open
Nobody has claimed this yet.
enhancement
PR Welcome!
- Dominant language
- C#
- Stars
- 5.3k
- Forks
- 510
- Avg merge
- 8d 5h
- Merged PRs (30d)
- 5
Description
Based on: https://github.com/dotnet/docfx/issues/2648#issuecomment-393918553
@xoofx, do you know of a good spec of manpage that would work on BSD, OSX, Linux and Solaris?
Pandoc's man writer is https://github.com/jgm/pandoc/blob/d32e8664498d799932927d9865ce71e014472ef3/src/Text/Pandoc/Writers/Man.hs. We probably need some specs to validate output.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the linked Pandoc Man writer and the referenced DocFX discussion, then identify the man-page specification needed for BSD, macOS, Linux, and Solaris. Done should include a defined renderer approach and specifications or tests that validate output across those platforms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100