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

Generate man pages using Go instead of Ruby #1990

Merged
merged 10 commits into from
Dec 29, 2018
Merged

Generate man pages using Go instead of Ruby #1990

merged 10 commits into from
Dec 29, 2018

Conversation

mislav
Copy link
Owner

@mislav mislav commented Dec 29, 2018

We used to rely on a Ruby tool called ronn to build our man pages (both "roff" and HTML formats) from a special markdown flavor called "ronn".

This drops that dependency and instead builds man pages using a new process called md2roff. It sources a more “standard” flavor of markdown (even though it still relies on a definition list syntax that's non-standard).

Since the HTML generator is rebuilt from the ground up, I took the liberty to refresh the CSS styles as well:

screen shot 2018-12-29 at 2 35 34 pm

I drew some initial inspiration from https://github.com/cpuguy83/go-md2man

Ref. #1919

@mislav mislav merged commit ee7cdc4 into master Dec 29, 2018
@mislav mislav deleted the md2roff branch December 29, 2018 15:34
netbsd-srcmastr pushed a commit to NetBSD/pkgsrc that referenced this pull request Jan 27, 2019
pkgsrc changes:
* Add logic to generate man page via pre-install target instead of
  generating it manually

Changes:
### Changes since v2.7
* New `hub api` command for scripting with GitHub API
  <mislav/hub#2016>
* Re-implement CLI flag parsing so that `--message <MSG>` is equivalent to
  `--message=<MSG>` <mislav/hub#2008>
* Re-implement `make man-pages` in Go instead of Ruby
  <mislav/hub#1990>
* `issue create --label` is now `issue create --labels` to align with
  existing documentation
* Output crash debugging information on stderr instead of stdout
* Build improvements:
   - respect environment LDFLAGS
   - strip the build path from resulting executable
   - enable reproducible builds with SOURCE_DATE_EPOCH
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 this pull request may close these issues.

1 participant