go-wkhtmltopdf 项目教程

go-wkhtmltopdf 项目教程

go-wkhtmltopdfGo bindings for wkhtmltopdf and high-level HTML to PDF conversion interface项目地址:https://gitcode.com/gh_mirrors/gow/go-wkhtmltopdf

1. 项目的目录结构及介绍

go-wkhtmltopdf/
├── examples/
│   ├── basic_usage.go
│   ├── converter_callbacks.go
│   ├── json_input.go
│   ├── web_page_server.go
│   └── configurable_web_page_server.go
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── converter.go
├── go.mod
├── object.go
├── object_registry.go
├── option.go
├── pdf.go

• examples/: 包含多个示例文件，展示如何使用 go-wkhtmltopdf 包。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则。
• CONTRIBUTING.md: 贡献指南。
• LICENSE: 许可证文件。
• README.md: 项目介绍和使用说明。
• converter.go: 转换器相关功能实现。
• go.mod: Go 模块文件。
• object.go: PDF 对象相关功能实现。
• object_registry.go: 对象注册表相关功能实现。
• option.go: 选项相关功能实现。
• pdf.go: 主要功能实现文件。

2. 项目的启动文件介绍

项目的启动文件通常是 examples/ 目录下的示例文件。以下是 basic_usage.go 的示例代码：

package main

import (
    "log"
    "os"
    pdf "github.com/adrg/go-wkhtmltopdf"
)

func main() {
    // Initialize library
    if err := pdf.Init(); err != nil {
        log.Fatal(err)
    }
    defer pdf.Destroy()

    // Create object from file
    object, err := pdf.NewObject("sample1.html")
    if err != nil {
        log.Fatal(err)
    }
    object.Header.ContentCenter = "[title]"
    object.Header.DisplaySeparator = true

    // Create object from URL
    object2, err := pdf.NewObject("https://google.com")
    if err != nil {
        log.Fatal(err)
    }
    object2.Footer.ContentLeft = "[date]"
    object2.Footer.ContentCenter = "Sample footer information"
    object2.Footer.ContentRight = "[page]"
    object2.Footer.DisplaySeparator = true

    // Create PDF
    pdf.AddObject(object)
    pdf.AddObject(object2)

    // Generate PDF
    if err := pdf.Generate(); err != nil {
        log.Fatal(err)
    }
}

3. 项目的配置文件介绍

项目没有明确的配置文件，但可以通过代码中的选项进行配置。以下是一些常见的配置选项示例：

object.Header.ContentCenter = "[title]"
object.Header.DisplaySeparator = true
object2.Footer.ContentLeft = "[date]"
object2.Footer.ContentCenter = "Sample footer information"
object2.Footer.ContentRight = "[page]"
object2.Footer.DisplaySeparator = true

这些选项可以在创建 PDF 对象时进行设置，以自定义 PDF 的头部和尾部内容。

---

以上是 go-wkhtmltopdf 项目的基本教程，涵盖了项目的目录结构、启动文件和配置选项。希望这些信息对您有所帮助。

go-wkhtmltopdfGo bindings for wkhtmltopdf and high-level HTML to PDF conversion interface项目地址:https://gitcode.com/gh_mirrors/gow/go-wkhtmltopdf