Pyandoc 项目技术文档

Pyandoc 项目技术文档

pyandoc Python wrapper for Pandoc—the universal document converter. 项目地址: https://gitcode.com/gh_mirrors/py/pyandoc

1. 安装指南

1.1 系统要求

• Python 3.x
• Pandoc

1.2 安装步骤

1. 安装 Pandoc：

   • 访问 Pandoc 官方网站 下载并安装 Pandoc。
   • 确保 Pandoc 已正确安装并添加到系统路径中。

2. 安装 Pyandoc：

   • 使用 pip 安装 Pyandoc：

     pip install pyandoc
     

2. 项目使用说明

2.1 导入模块

首先，导入 Pyandoc 模块：

import pandoc

2.2 创建文档对象

创建一个 Document 对象，并设置其内容为 Markdown 格式：

doc = pandoc.Document()
doc.markdown = '''
# I am an H1 Tag

* bullet point
* more points
* point with [link](http://kennethreitz.com)!
'''

2.3 转换文档格式

将 Markdown 文档转换为 ReST 格式：

print(doc.rst)

输出结果：

I am an H1 Tag
==============

-  bullet point
-  more points
-  point with `link <http://kennethreitz.com>`_!

3. 项目 API 使用文档

3.1 Document 类

• Document(): 创建一个新的文档对象。
• Document.markdown: 设置或获取文档的 Markdown 内容。
• Document.rst: 获取文档的 ReST 格式内容。

3.2 支持的格式

Pyandoc 支持多种文档格式转换，包括但不限于：

• asciidoc
• beamer
• commonmark
• context
• docbook
• docx
• dokuwiki
• dzslides
• epub
• epub3
• fb2
• haddock
• html
• html5
• icml
• json (pandoc's AST)
• latex
• man
• markdown
• markdown_github
• markdown_mmd
• markdown_phpextra
• markdown_strict
• mediawiki
• native
• odt
• opendocument
• opml
• org
• pdf
• plain
• revealjs
• rst
• rtf
• s5
• slideous
• slidy
• texinfo
• textile

4. 项目安装方式

4.1 通过 pip 安装

使用以下命令安装 Pyandoc：

pip install pyandoc

4.2 手动安装

1. 克隆项目仓库：

   git clone https://github.com/yourusername/pyandoc.git
   

2. 进入项目目录并安装：

   cd pyandoc
   python setup.py install
   

通过以上步骤，您可以顺利安装并使用 Pyandoc 项目进行文档格式转换。

pyandoc Python wrapper for Pandoc—the universal document converter. 项目地址: https://gitcode.com/gh_mirrors/py/pyandoc