Pandoc全方位指南：文档转换神器

文档格式转换

需积分: 48 155 浏览量更新于2024-07-18 1 收藏 308KB PDF 举报

身份认证购VIP最低享 7 折!

领优惠券(最高得80元）

"Pandoc 使用手册" Pandoc是一款强大的文档转换工具，由John MacFarlane用Haskell编程语言编写，能实现几乎任何文档格式之间的相互转换。它支持的格式包括但不限于Markdown、HTML、LaTeX、Word文档（.docx）、PDF等。这使得用户可以在不同的写作环境和需求之间轻松切换。 1. 使用Pandoc - **指定格式**：Pandoc通过命令行参数来指定输入和输出的文件格式，例如`pandoc input.txt -o output.html`会将Markdown格式的`input.txt`转换为HTML。 - **字符编码**：默认情况下，Pandoc假设输入文件是UTF-8编码，但可以通过`--encoding`选项指定其他编码。 - **创建PDF**：要创建PDF，需指定`-t pdf`，Pandoc通常会利用LaTeX作为中间格式来生成PDF。 - **从网络读取**：`--webpage`选项允许Pandoc直接从网页抓取内容并进行转换。 2. 选项 - **通用选项**：如`--verbose`用于增加日志输出，`--standalone`则生成独立的文件，不包含外部依赖。 - **阅读器选项**：控制解析输入文件的方式，如`--smart`开启智能引号和标点转换。 - **写入器选项**：影响输出文件的格式，如`--reference-doc`用于设置参考模板。 - **特定写入器选项**：针对特定格式，如`--pdf-engine`用于指定PDF生成引擎。 - **引用渲染**：Pandoc支持多种引用样式，通过`--csl`选项指定引用样式文件。 - **数学公式渲染**：在HTML中，可以使用`--mathjax`或`--katex`选项处理数学公式。 3. 模板 - **模板**：Pandoc使用模板系统自定义输出格式的布局和样式，可通过`--template`选项指定模板文件。 - **变量**：Pandoc设置了一系列变量，如标题、作者等，可在模板中使用。 - **语言变量**：支持多语言，通过`--lang`指定输出语言，影响如日期格式等。 - **特定格式变量**：如Markdown、LaTeX和ConTeXt等都有自己的变量集，可以根据需要设置。 4. 扩展与特性 - **扩展**：Pandoc支持Markdown的多种扩展，如表格、脚注、自定义CSS等。 - **排版**：包括自动换行、段落处理等。 - **标题和部分**：支持Setext和ATX两种风格的标题，以及自定义ID。 - **代码块**：提供缩进代码块、fenced代码块，以及代码高亮。 - **列表**：支持无序和有序列表，可以嵌套。 - **其他扩展**：包括链接、图片、引用等。 5. Pandoc的Markdown哲学 - **兼容性**：Pandoc的Markdown旨在与其他Markdown变种兼容。 - **扩展性**：允许通过扩展实现更多功能，而不破坏基本语法的简洁性。 - **可预测性**：输出结果应一致且可预测，不受未明确规定的输入影响。 Pandoc的灵活性和广泛支持的格式使其成为处理各种文档转换任务的理想选择，无论是简单的文本格式转换还是复杂的定制输出，Pandoc都能胜任。了解和熟练掌握Pandoc的各项功能，将极大提升工作效率，尤其是在跨平台、跨格式的文档处理中。

资源详情

资源推荐

Pandoc User’s Guide Options

extension corresponding to the writer will be added, so that --template=special looks

for special.html for HTML output. If the template is not found, pandoc will search for

it in the templates subdirectory of the user data directory (see --data-dir). If this op-

tion is not used, a default template appropriate for the output format will be used (see

-D/--print-default-template).

-V KEY [=VAL], --variable=KEY [:VAL] Set the template variable KEY to the value VAL when ren-

dering the document in standalone mode. This is generally only useful when the --template op-

tion is used to specify a custom template, since pandoc automatically sets the variables used in

the default templates. If no VAL is specified, the key will be given the value true.

-D FORMAT, --print-default-template=FORMAT Print the system default template for an out-

put FORMAT. (See -t for a list of possible FORMATs.) Templates in the user data directory are

ignored.

--print-default-data-file=FILE Print a system default data file. Files in the user data directory

are ignored.

--eol=crlf|lf|native Manually specify line endings: crlf (Windows), lf (macOS/Linux/UNIX), or

native (line endings appropriate to the OS on which pandoc is being run). The default is native.

--dpi=NUMBER Specify the dpi (dots per inch) value for conversion from pixels to inch/centimeters

and vice versa. The default is 96dpi. Technically, the correct term would be ppi (pixels per inch).

--wrap=auto|none|preserve Determine how text is wrapped in the output (the source code, not the

rendered version). With auto (the default), pandoc will attempt to wrap lines to the column width

specified by --columns (default 72). With none, pandoc will not wrap lines at all. With preserve,

pandoc will attempt to preserve the wrapping from the source document (that is, where there are

nonsemantic newlines in the source, there will be nonsemantic newlines in the output as well).

Automatic wrapping does not currently work in HTML output.

--columns=NUMBER Specify length of lines in characters. This affects text wrapping in the generated

source code (see --wrap). It also affects calculation of column widths for plain text tables (see

Tables below).

--toc, --table-of-contents Include an automatically generated table of contents (or, in the case of

latex, context, docx, odt, opendocument, rst, or ms, an instruction to create one) in the output

document. This option has no effect on man, docbook4, docbook5, or jats output.

--toc-depth=NUMBER Specify the number of section levels to include in the table of contents. The

default is 3 (which means that level 1, 2, and 3 headers will be listed in the contents).

--strip-comments Strip out HTML comments in the Markdown or Textile source, rather than passing

them on to Markdown, Textile or HTML output as raw HTML. This does not apply to HTML

comments inside raw HTML blocks when the markdown_in_html_blocks extension is not set.

--no-highlight Disables syntax highlighting for code blocks and inlines, even when a language at-

tribute is given.

v 2.2 13

Pandoc User’s Guide Options

--highlight-style=STYLE|FILE Specifies the coloring style to be used in highlighted source

code. Options are pygments (the default), kate, monochrome, breezeDark, espresso, zenburn,

haddock, and tango. For more information on syntax highlighting in pandoc, see Syntax

highlighting, below. See also --list-highlight-styles.

Instead of a STYLE name, a JSON file with extension .theme may be supplied. This will be parsed

as a KDE syntax highlighting theme and (if valid) used as the highlighting style.

To generate the JSON version of an existing style, use --print-highlight-style.

--print-highlight-style=STYLE|FILE Prints a JSON version of a highlighting style, which can be

modified, saved with a .theme extension, and used with --highlight-style.

--syntax-definition=FILE Instructs pandoc to load a KDE XML syntax definition file, which will

be used for syntax highlighting of appropriately marked code blocks. This can be used to add

support for new languages or to use altered syntax definitions for existing languages.

-H FILE, --include-in-header=FILE Include contents of FILE, verbatim, at the end of the header.

This can be used, for example, to include special CSS or JavaScript in HTML documents. This

option can be used repeatedly to include multiple files in the header. They will be included in the

order specified. Implies --standalone.

-B FILE, --include-before-body=FILE Include contents of FILE, verbatim, at the beginning of the

document body (e.g. after the <body> tag in HTML, or the \begin{document} command in La-

TeX). This can be used to include navigation bars or banners in HTML documents. This option

can be used repeatedly to include multiple files. They will be included in the order specified. Im-

plies --standalone.

-A FILE, --include-after-body=FILE Include contents of FILE, verbatim, at the end of the docu-

ment body (before the </body> tag in HTML, or the \end{document} command in LaTeX). This

option can be used repeatedly to include multiple files. They will be included in the order speci-

fied. Implies --standalone.

--resource-path=SEARCHPATH List of paths to search for images and other resources. The

paths should be separated by : on Linux, UNIX, and macOS systems, and by ; on Windows. If

--resource-path is not specified, the default resource path is the working directory. Note that,

if --resource-path is specified, the working directory must be explicitly listed or it will not be

searched. For example: --resource-path=.:test will search the working directory and the

test subdirectory, in that order.

--request-header=NAME:VAL Set the request header NAME to the value VAL when making HTTP

requests (for example, when a URL is given on the command line, or when resources used in a

document must be downloaded).

Options affecting specific writers

--self-contained Produce a standalone HTML file with no external dependencies, using data:

URIs to incorporate the contents of linked scripts, stylesheets, images, and videos. Implies

--standalone. The resulting file should be “self-contained,” in the sense that it needs no

v 2.2 14

Pandoc User’s Guide Options

external files and no net access to be displayed properly by a browser. This option works only

with HTML output formats, including html4, html5, html+lhs, html5+lhs, s5, slidy, slideous,

dzslides, and revealjs. Scripts, images, and stylesheets at absolute URLs will be downloaded;

those at relative URLs will be sought relative to the working directory (if the first source file is

local) or relative to the base URL (if the first source file is remote). Elements with the attribute

data-external="1" will be left alone; the documents they link to will not be incorporated in

the document. Limitation: resources that are loaded dynamically through JavaScript cannot be

incorporated; as a result, --self-contained does not work with --mathjax, and some advanced

features (e.g. zoom or speaker notes) may not work in an offline “self-contained” reveal.js

slide show.

--html-q-tags Use <q> tags for quotes in HTML.

--ascii Use only ASCII characters in output. Currently supported for XML and HTML formats (which

use numerical entities instead of UTF-8 when this option is selected) and for groff ms and man

(which use hexadecimal escapes).

--reference-links Use reference-style links, rather than inline links, in writing Markdown or re-

StructuredText. By default inline links are used. The placement of link references is affected

by the --reference-location option.

--reference-location = block|section|document Specify whether footnotes (and references, if

reference-links is set) are placed at the end of the current (top-level) block, the current section,

or the document. The default is document. Currently only affects the markdown writer.

--atx-headers Use ATX-style headers in Markdown and AsciiDoc output. The default is to use setext-

style headers for levels 1-2, and then ATX headers. (Note: for gfm output, ATX headers are always

used.)

--top-level-division=[default|section|chapter|part]

Treat top-level headers as the given di-

vision type in LaTeX, ConTeXt, DocBook, and TEI output. The hierarchy order is part, chapter,

then section; all headers are shifted such that the top-level header becomes the specified type.

The default behavior is to determine the best division type via heuristics: unless other conditions

apply, section is chosen. When the LaTeX document class is set to report, book, or memoir (un-

less the article option is specified), chapter is implied as the setting for this option. If beamer

is the output format, specifying either chapter or part will cause top-level headers to become

\part{..}, while second-level headers remain as their default type.

-N, --number-sections Number section headings in LaTeX, ConTeXt, HTML, or EPUB output. By

default, sections are not numbered. Sections with class unnumbered will never be numbered,

even if --number-sections is specified.

--number-offset=NUMBER[,NUMBER,…] Offset for section headings in HTML output (ignored

in other output formats). The first number is added to the section number for top-level headers,

the second for second-level headers, and so on. So, for example, if you want the first top-level

header in your document to be numbered “6”, specify --number-offset=5. If your document

starts with a level-2 header which you want to be numbered “1.5”, specify --number-offset=1,4.

Offsets are 0 by default. Implies --number-sections.

v 2.2 15

Pandoc User’s Guide Options

--listings Use the listings package for LaTeX code blocks

-i, --incremental Make list items in slide shows display incrementally (one by one). The default is

for lists to be displayed all at once.

--slide-level=NUMBER Specifies that headers with the specified level create slides (for beamer, s5,

slidy, slideous, dzslides). Headers above this level in the hierarchy are used to divide the slide

show into sections; headers below this level create subheads within a slide. Note that content that

is not contained under slide-level headers will not appear in the slide show. The default is to set

the slide level based on the contents of the document; see Structuring the slide show.

--section-divs Wrap sections in <section> tags (or <div> tags for html4), and attach identifiers to

the enclosing <section> (or <div>) rather than the header itself. See Header identifiers, below.

--email-obfuscation=none|javascript|references Specify a method for obfuscating mailto:

links in HTML documents. none leaves mailto: links as they are. javascript obfuscates

them using JavaScript. references obfuscates them by printing their letters as decimal or

hexadecimal character references. The default is none.

--id-prefix=STRING Specify a prefix to be added to all identifiers and internal links in HTML and

DocBook output, and to footnote numbers in Markdown and Haddock output. This is useful for

preventing duplicate identifiers when generating fragments to be included in other pages.

-T STRING, --title-prefix=STRING Specify STRING as a prefix at the beginning of the title that

appears in the HTML header (but not in the title as it appears at the beginning of the HTML body).

Implies --standalone.

-c URL, --css=URL Link to a CSS style sheet. This option can be used repeatedly to include multiple

files. They will be included in the order specified.

A stylesheet is required for generating EPUB. If none is provided using this option (or the

stylesheet metadata field), pandoc will look for a file epub.css in the user data directory (see

--data-dir). If it is not found there, sensible defaults will be used.

--reference-doc=FILE Use the specified file as a style reference in producing a docx or ODT file.

Docx For best results, the reference docx should be a modified version of a docx file produced

using pandoc. The contents of the reference docx are ignored, but its stylesheets and doc-

ument properties (including margins, page size, header, and footer) are used in the new

docx. If no reference docx is specified on the command line, pandoc will look for a file

reference.docx in the user data directory (see --data-dir). If this is not found either,

sensible defaults will be used.

To produce a custom reference.docx, first get a copy of the default reference.docx:

pandoc --print-default-data-file reference.docx > custom-reference.docx.

Then open custom-reference.docx in Word, modify the styles as you wish, and save

the file. For best results, do not make changes to this file other than modifying the

styles used by pandoc: [paragraph] Normal, Body Text, First Paragraph, Compact, Title,

Subtitle, Author, Date, Abstract, Bibliography, Heading 1, Heading 2, Heading 3, Heading

4, Heading 5, Heading 6, Heading 7, Heading 8, Heading 9, Block Text, Footnote Text,

v 2.2 16

剩余79页未读，继续阅读

w7513118

粉丝: 0
资源: 4

Pandoc全方位指南：文档转换神器

pandoc使用说明.txt

pandoc-2.1.2-linux.tar

pandoc-1.17.2-windows.msi

怎么使用pandoc使用代码将tex文件转换为 Word 格式

PANDOC使用教程

pandoc使用教程

typora的pandoc安装使用

typora怎么使用pandoc

pandox怎么用_如何使用pandoc将mathjax转换为latex？

pandoc安装使用

pandoc-3.1.6.1使用

linux pandoc

更新pandoc的版本

typora使用pandoc

typora怎么安装pandoc

pandoc 无法显示图片 obsidian

typora如何配置pandoc

pandoc windows

centos7 安装pandoc

使用pandoc将一个名叫zcyl.pdf的文档转换成md

最新资源