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

Add support for Pandoc Markdown #327

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

elliottslaughter
Copy link
Contributor

This is another part of the solution to #162, along with #326. This PR adds support for Pandoc, which is a very robust and featureful Markdown processor written in Haskell. Since there's not really any way to directly integrate the library we just assume it's on PATH and call it as an external program.

I've tried to minimize the number of temporary files created, but apparently Lua has no popen2 equivalent so I think this is the best we can do (without additional dependencies or extensions).

I've confirmed that this works to at least a basic level with Pandoc's built-in syntax highlighting if you use it in combination with #326 and set pretty="none".

pandoc = function(format)
return function(text)
local out_filename = os.tmpname()
local in_file = io.popen("pandoc -f markdown -t html -o " .. out_filename .. " -", "w")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this PR looks good and I'd love to see it merged, but this bit of coding seems counter intuitive to me. You're writing to something called "in_file" and reading from "out_file" — but it's really tricky to realize whose perspective on in and out is being used here. I suggest using names that better represent what they are ... tmpfile, stdin or fifo or some such?

Otherwise I'll give this a test drive and make sure it works, then merge.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe markdown_file and html_file (based on the contents)?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, that sounds clear.

@alerque
Copy link
Member

alerque commented Sep 29, 2020

Because I merged cmark support from another PR, this will require a minor bit of conflict resolution.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants