如何在 Hakyll 中使用 Pandoc 过滤器？

Question

不好意思问这样的问题。但我真的是Haskell的新手。在网上查了一整天也没找到例子。

我有一个用 python (tikzcd.py) 编写的 pandoc 过滤器。我想使用该过滤器来处理我的博客文章。

我想我需要使用 unixFilter 或 pandocCompileWithTransform 但我对 Haskell 的了解确实不足以自己找到解决方案。

那么，有人可以给我举个例子吗？

------------U--P--D--A--T--E--S--------------

~~@Michael 给出了使用 pandocCompileWithTransformM 和 unixFilter 的解决方案。有用。但是有个问题。~~

~~当从命令行使用过滤器时，我会做的是~~

pandoc -t json -READEROPTIONS input.markdown | ./filter.py | pandoc -f JSON -WRITEROPTIONS -o output.html

~~or equivalently~~
pandoc --filter ./filter.py -READEROPTIONS -WRITEROPTIONS -o html
~~This command is shorter but it doesn't show the procedures.~~

~~但是对于pandocCompilerTransformM，它会做类似~~

的事情

pandoc -t html -READEROPTIONS -WRITEROPTIONS input.mardown | pandoc -t JSON | ./filter.py | pandoc -f JSON -WRITEROPTIONS -o output.html

不同的是传给filter.py的文本不一样：一个是markdown直接产生的内容，一个是HTML产生的一些文本是从markdown产生的。如您所知，来回转换总是会产生意想不到的问题。所以我觉得可能有更好的解决办法。

PS。我开始学习 Haskell。我希望有一天我能自己解决这个问题。谢谢！

Answer 1

最后我想你会同时使用两者。使用这个 https://github.com/listx/listx_blog/blob/master/blog.hs as a model, the following will have the same shape as transformer has in it. transformer is used on lines 69-80 for 'posts'——这是 pandocCompilerWithTransformM 的第三个参数，这是一个 (Pandoc -> Compiler Pandoc) 这里你需要添加绝对路径到你的 python 过滤器——或者名称，如果它在 $PATH 中——以及 reader 和编写器选项（例如 defaultHakyllReaderOptions 和 defaultHakyllWriterOptions）

import Text.Pandoc
import Hakyll

type Script = String 

transformer
  :: Script         -- e.g. "/absolute/path/filter.py"
  -> ReaderOptions  -- e.g.  defaultHakyllReaderOptions
  -> WriterOptions  -- e.g.  defaultHakyllWriterOptions
  -> (Pandoc -> Compiler Pandoc)
transformer script reader_opts writer_opts pandoc = 
    do let input_json = writeJSON writer_opts pandoc
       output_json <- unixFilter script [] input_json
       return $ 
          -- either (error.show) id $  -- this line needs to be uncommented atm.
          readJSON reader_opts output_json

类似地，在使用 (return . pandocTransform) 的地方可能会使用 (transformer "/usr/local/bin/myfilter.py" defaultHakyllReaderOptions defaultHakyllWriterOptions)，在此 example gist

的第 125 行

对于调试，您可以将所有事情外包给 unixFilter:

transform :: Script -> String -> Compiler String
transform script md = do json0 <- unixFilter pandoc input_args md
                         json1 <- unixFilter script [] json0
                         unixFilter pandoc output_args json1
 where
   pandoc = "pandoc"
   input_args = words "-f markdown -t json" -- add others
   output_args = words "-f json -t html"    -- add others

do 块的三行相当于 pandoc -t json | filter.py | pandoc -f json 中带有任何附加参数的 unix 管道的阶段。

我想也许你是对的，这里来回多了一层 pandoc。 pandocCompilerWithTransform(M) 函数用于直接 Pandoc-> Pandoc 函数 - 它将应用于 Pandoc hakyll 。我认为我们应该放弃这个并直接使用 Pandoc 库。 unixCompile 的用法可能是这样的。

transformXLVI :: Script -> ReaderOptions -> WriterOptions -> String  -> Compiler Html
transformXLVI script ropts wopts = fmap fromJSON . unixFilter script [] . toJSON 
  where 
    toJSON   = writeJSON wopts 
    --           . either (error . show) id -- for pandoc > 1.14
               . readMarkdown ropts 
    fromJSON = writeHtml wopts
    --           . either (error . show) id
               . readJSON ropts

我希望这些原则能从这些变化中浮现出来！这应该与前面的 transform 几乎相同；我们正在使用 pandoc 库来代替对 pandoc 可执行文件的调用。

如何在 Hakyll 中使用 Pandoc 过滤器？

How to use Pandoc filter within Hakyll?

haskell

filter

pandoc

hakyll