Tissevert/pandoc
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

CONTRIBUTING.md: update modules overview

Browse source
This commit is contained in:
Albert Krewinkel 2021-06-07 20:10:56 +02:00
parent 21cc52abe3
commit 94e8a650fb
No known key found for this signature in database
GPG key ID: 388DC0B21F631124
1 changed files with 6 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -406,11 +406,11 @@ The library is structured as follows:
tree automatically. tree automatically.
- `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*` - `Text.Pandoc.Readers.*` are the readers, and `Text.Pandoc.Writers.*`
are the writers. are the writers.
- `Text.Pandoc.Biblio` is a utility module for formatting citations - `Text.Pandoc.Citeproc.*` contain the code for citation handling,
using citeproc-hs. including an interface to the [citeproc] library.
- `Text.Pandoc.Data` is used to embed data files when the `embed_data_files` - `Text.Pandoc.Data` is used to embed data files when the `embed_data_files`
cabal flag is used. It is generated from `src/Text/Pandoc/Data.hsb` using cabal flag is used.
the preprocessor [hsb2hs]. - `Text.Pandoc.Emoji` is a thin wrapper around [emojis].
- `Text.Pandoc.Highlighting` contains the interface to the - `Text.Pandoc.Highlighting` contains the interface to the
skylighting library, which is used for code syntax highlighting. skylighting library, which is used for code syntax highlighting.
- `Text.Pandoc.ImageSize` is a utility module containing functions for - `Text.Pandoc.ImageSize` is a utility module containing functions for
@ -421,7 +421,6 @@ The library is structured as follows:
- `Text.Pandoc.PDF` contains functions for producing a PDF from a - `Text.Pandoc.PDF` contains functions for producing a PDF from a
LaTeX source. LaTeX source.
- `Text.Pandoc.Parsing` contains parsing functions used in multiple readers. - `Text.Pandoc.Parsing` contains parsing functions used in multiple readers.
- `Text.Pandoc.Pretty` is a pretty-printing library specialized to
the needs of pandoc. the needs of pandoc.
- `Text.Pandoc.SelfContained` contains functions for making an HTML - `Text.Pandoc.SelfContained` contains functions for making an HTML
file "self-contained," by importing remotely linked images, CSS, file "self-contained," by importing remotely linked images, CSS,
@ -456,6 +455,8 @@ you may want to consider submitting a pull request to the
[EditorConfig]: https://editorconfig.org/ [EditorConfig]: https://editorconfig.org/
[Haskell platform]: https://www.haskell.org/platform/ [Haskell platform]: https://www.haskell.org/platform/
[hlint]: https://hackage.haskell.org/package/hlint [hlint]: https://hackage.haskell.org/package/hlint
[citeproc]: https://hackage.haskell.org/package/citeproc
[emojis]: https://hackage.haskell.org/package/emojis
[hsb2hs]: https://hackage.haskell.org/package/hsb2hs [hsb2hs]: https://hackage.haskell.org/package/hsb2hs
[pre-commit hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks [pre-commit hook]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
[GitHub labels]: https://github.com/jgm/pandoc/labels [GitHub labels]: https://github.com/jgm/pandoc/labels