From ccb828894b6c9aae056a6861c20c4d6807035d9f Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Mon, 23 Mar 2015 11:35:44 -0700 Subject: Added CommonMark writer. Added `Text.Pandoc.Writers.CommonMark`, exporting `writeCommonMark`. --- README | 83 ++++++++++++++++++++++++++++++++++-------------------------------- 1 file changed, 43 insertions(+), 40 deletions(-) (limited to 'README') diff --git a/README b/README index db3d93ae1..412235c09 100644 --- a/README +++ b/README @@ -158,22 +158,22 @@ General options : Specify input format. *FORMAT* can be `native` (native Haskell), `json` (JSON version of native AST), `markdown` (pandoc's - extended markdown), `markdown_strict` (original unextended markdown), - `markdown_phpextra` (PHP Markdown Extra extended markdown), - `markdown_github` (github extended markdown), - `commonmark` (CommonMark markdown), - `textile` (Textile), `rst` (reStructuredText), `html` (HTML), - `docbook` (DocBook), `t2t` (txt2tags), `docx` (docx), `epub` (EPUB), - `opml` (OPML), `org` (Emacs Org-mode), `mediawiki` (MediaWiki markup), - `twiki` (TWiki markup), `haddock` (Haddock markup), or `latex` (LaTeX). - If `+lhs` is appended to `markdown`, `rst`, - `latex`, or `html`, the input will be treated as literate Haskell - source: see [Literate Haskell support](#literate-haskell-support), - below. Markdown syntax extensions can be individually enabled or - disabled by appending `+EXTENSION` or `-EXTENSION` to the format - name. So, for example, `markdown_strict+footnotes+definition_lists` - is strict markdown with footnotes and definition lists enabled, - and `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown + extended markdown), `markdown_strict` (original unextended + markdown), `markdown_phpextra` (PHP Markdown Extra extended + markdown), `markdown_github` (github extended markdown), + `commonmark` (CommonMark markdown), `textile` (Textile), `rst` + (reStructuredText), `html` (HTML), `docbook` (DocBook), `t2t` + (txt2tags), `docx` (docx), `epub` (EPUB), `opml` (OPML), `org` + (Emacs Org-mode), `mediawiki` (MediaWiki markup), `twiki` (TWiki + markup), `haddock` (Haddock markup), or `latex` (LaTeX). If + `+lhs` is appended to `markdown`, `rst`, `latex`, or `html`, the + input will be treated as literate Haskell source: see [Literate + Haskell support](#literate-haskell-support), below. Markdown + syntax extensions can be individually enabled or disabled by + appending `+EXTENSION` or `-EXTENSION` to the format name. So, for + example, `markdown_strict+footnotes+definition_lists` is strict + markdown with footnotes and definition lists enabled, and + `markdown-pipe_tables+hard_line_breaks` is pandoc's markdown without pipe tables and with hard line breaks. See [Pandoc's markdown](#pandocs-markdown), below, for a list of extensions and their names. @@ -182,30 +182,33 @@ General options : Specify output format. *FORMAT* can be `native` (native Haskell), `json` (JSON version of native AST), `plain` (plain text), - `markdown` (pandoc's extended markdown), `markdown_strict` (original - unextended markdown), `markdown_phpextra` (PHP Markdown extra - extended markdown), `markdown_github` (github extended markdown), - `rst` (reStructuredText), `html` (XHTML 1), `html5` (HTML 5), - `latex` (LaTeX), `beamer` (LaTeX beamer slide show), - `context` (ConTeXt), `man` (groff man), `mediawiki` (MediaWiki markup), - `dokuwiki` (DokuWiki markup), - `textile` (Textile), `org` (Emacs Org-Mode), `texinfo` (GNU Texinfo), - `opml` (OPML), `docbook` (DocBook), `opendocument` (OpenDocument), `odt` - (OpenOffice text document), `docx` (Word docx), `haddock` (Haddock - markup), `rtf` (rich text format), `epub` (EPUB v2 book), `epub3` - (EPUB v3), `fb2` (FictionBook2 e-book), `asciidoc` (AsciiDoc), - `icml` (InDesign ICML), `slidy` (Slidy HTML and javascript slide show), - `slideous` (Slideous HTML and javascript slide show), `dzslides` - (DZSlides HTML5 + javascript slide show), `revealjs` (reveal.js - HTML5 + javascript slide show), `s5` (S5 HTML and javascript slide show), - or the path of a custom lua writer (see [Custom writers](#custom-writers), - below). Note that `odt`, `epub`, and `epub3` output will not be directed - to *stdout*; an output filename must be specified using the `-o/--output` - option. If `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`, - `html`, or `html5`, the output will be rendered as literate Haskell - source: see [Literate Haskell support](#literate-haskell-support), below. - Markdown syntax extensions can be individually enabled or disabled by - appending `+EXTENSION` or `-EXTENSION` to the format name, as described + `markdown` (pandoc's extended markdown), `markdown_strict` + (original unextended markdown), `markdown_phpextra` (PHP Markdown + extra extended markdown), `markdown_github` (github extended + markdown), `commonmark` (CommonMark markdown), `rst` + (reStructuredText), `html` (XHTML 1), `html5` (HTML 5), `latex` + (LaTeX), `beamer` (LaTeX beamer slide show), `context` (ConTeXt), + `man` (groff man), `mediawiki` (MediaWiki markup), `dokuwiki` + (DokuWiki markup), `textile` (Textile), `org` (Emacs Org-Mode), + `texinfo` (GNU Texinfo), `opml` (OPML), `docbook` (DocBook), + `opendocument` (OpenDocument), `odt` (OpenOffice text document), + `docx` (Word docx), `haddock` (Haddock markup), `rtf` (rich text + format), `epub` (EPUB v2 book), `epub3` (EPUB v3), `fb2` + (FictionBook2 e-book), `asciidoc` (AsciiDoc), `icml` (InDesign + ICML), `slidy` (Slidy HTML and javascript slide show), `slideous` + (Slideous HTML and javascript slide show), `dzslides` (DZSlides + HTML5 + javascript slide show), `revealjs` (reveal.js HTML5 + + javascript slide show), `s5` (S5 HTML and javascript slide show), + or the path of a custom lua writer (see [Custom + writers](#custom-writers), below). Note that `odt`, `epub`, and + `epub3` output will not be directed to *stdout*; an output + filename must be specified using the `-o/--output` option. If + `+lhs` is appended to `markdown`, `rst`, `latex`, `beamer`, + `html`, or `html5`, the output will be rendered as literate + Haskell source: see [Literate Haskell + support](#literate-haskell-support), below. Markdown syntax + extensions can be individually enabled or disabled by appending + `+EXTENSION` or `-EXTENSION` to the format name, as described above under `-f`. `-o` *FILE*, `--output=`*FILE* -- cgit v1.2.3