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

change markdown to roff converter from pandoc tool to md2man gem #13

Closed
wants to merge 1 commit into from
Closed

change markdown to roff converter from pandoc tool to md2man gem #13

wants to merge 1 commit into from

Conversation

Dhul-Husni
Copy link

@Dhul-Husni Dhul-Husni commented Aug 28, 2018

convert markdown to roff using a gem instead of an external library.
This increases the flexibility of um; to run on devices that may not have pandoc installed or supported.
requested in #10
ps: I have also made a pull request on the homebrew tap repo to add md2man gem

@forquare
Copy link

I've got a Makefile for a FreeBSD Port of Um, but pandoc takes about a day to compile on my computer and I need to compile it six times (twice for each supported release (i386 and x64), this is the only thing holding me off from submitting the port to get it into the FreeBSD repository.

Switching to something like this brings down the compilation time for any FreeBSD users wishing to compile all of their software (which many do).

@sinclairtarget
Copy link
Owner

This is awesome! Hope to test this out myself soon. My only major concern is that md2man will expect a different flavor of Markdown. Do you know what the major differences might be?

@iajrz
Copy link
Contributor

iajrz commented Sep 19, 2018

md2man is a just a wrapper for pandoc, though. This work will be rendered moot when gem that does the translation itself is integrated, and that think that's what ultimately will happen if we're going to fulfill the intent behind dropping the pandoc dependency - namely, more portability as implied by #6 and #4 .

@iajrz
Copy link
Contributor

iajrz commented Sep 19, 2018

Upon further review: it seems better to use kramdown as mentioned in #10 instead of running with this PR.

@leggettc18
Copy link

@iajrz I think they were referring to the rubygem md2man found here, which is not a wrapper around pandoc. I do agree, however, that kramdown MIGHT be better, as it does not have any additional runtime dependencies.

@sinclairtarget
Copy link
Owner

Um now uses Kramdown to parse Markdown files into roff man pages. Pandoc is no longer a dependency.

Because Kramdown's Markdown is not the same as Pandoc's Markdown, this may break your um pages. See UPGRADE.md for more info.

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.

5 participants