Skip to content
This repository has been archived by the owner on Oct 18, 2020. It is now read-only.

Commit

Permalink
Added link to GroovyDoc in README file
Browse files Browse the repository at this point in the history
  • Loading branch information
dfrommi committed Mar 29, 2015
1 parent 7bee510 commit b41c6ef
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pandoc -f SOURCEFORMAT -t TARGETFORMAT --filter ./Behead.groovy
Filter script `Behead.groovy` has to be executable. For more details on Pandoc filters see [Pandoc scripting guide](http://johnmacfarlane.net/pandoc/scripting.html)

## Development guide
The GroovyPandoc library is not working on plain JSON format, but instead converts it to object tree. Each Pandoc element has a corresponding Groovy class. See package `net.frommknecht.pandoc.types` for details.
The GroovyPandoc library is not working on plain JSON format, but instead converts it to object tree. Each Pandoc element has a corresponding Groovy class. See package `net.frommknecht.pandoc.types` in [library's GroovyDoc](http://dfrommi.github.io/groovy-pandoc/) for details.

The filter entry point is the static method `toJSONFilter` of class `net.frommknecht.pandoc.Pandoc`. It walks through Pandoc AST using breadth first search and calls the provided closure for each element. Typically, the filter closure first checks if the element is of interest and then transforms it.

Expand Down

0 comments on commit b41c6ef

Please sign in to comment.