Skip to content

Create from Markdown

Convert Markdown content into a properly formatted PDF document. Supports headings, paragraphs, bold/italic text, lists, code blocks, blockquotes, and more.

Quick Example

Python

from pdf_oxide import Pdf

pdf = Pdf.from_markdown("# Hello\n\nWorld")
pdf.save("out.pdf")

WASM

import { WasmPdf } from "pdf-oxide-wasm";
import { writeFileSync } from "fs";

const pdf = WasmPdf.fromMarkdown("# Hello\n\nWorld");
writeFileSync("out.pdf", pdf.toBytes());

Rust

use pdf_oxide::api::Pdf;

let pdf = Pdf::from_markdown("# Hello\n\nWorld")?;
pdf.save("out.pdf")?;

Go

package main

import (
    "log"
    pdfoxide "github.com/yfedoseev/pdf_oxide/go"
)

func main() {
    pdf, err := pdfoxide.FromMarkdown("# Hello\n\nWorld")
    if err != nil { log.Fatal(err) }
    defer pdf.Close()

    if err := pdf.Save("out.pdf"); err != nil { log.Fatal(err) }
}

C#

using PdfOxide;

using var pdf = Pdf.FromMarkdown("# Hello\n\nWorld");
pdf.Save("out.pdf");

Supported Markdown Syntax

Syntax Markdown Description
Heading 1 # Title Large bold heading
Heading 2 ## Section Medium bold heading
Heading 3 ### Subsection Small heading
Heading 4-6 #### ... Minor headings
Paragraph Plain text with blank line Body text with word wrapping
Bold **bold** Bold text
Italic *italic* Italic text
Unordered list - item or * item Bulleted list
Ordered list 1. item Numbered list
Code block ``` fenced blocks Monospace code
Inline code `code` Inline monospace
Blockquote > quoted text Indented quotation

Full API Reference

Pdf::from_markdown(content) (Static Method)

Creates a PDF from Markdown content using default settings (Letter page, 72pt margins, 12pt Helvetica).

Rust:

use pdf_oxide::api::Pdf;

let pdf = Pdf::from_markdown("# Report\n\nFindings are summarized below.")?;
pdf.save("report.pdf")?;

JavaScript:

import { WasmPdf } from "pdf-oxide-wasm";
import { writeFileSync } from "fs";

const pdf = WasmPdf.fromMarkdown("# Report\n\nFindings are summarized below.");
writeFileSync("report.pdf", pdf.toBytes());

Python:

from pdf_oxide import Pdf

pdf = Pdf.from_markdown("# Report\n\nFindings are summarized below.")
pdf.save("report.pdf")

Go:

pdf, err := pdfoxide.FromMarkdown("# Report\n\nFindings are summarized below.")
if err != nil { log.Fatal(err) }
defer pdf.Close()
_ = pdf.Save("report.pdf")

C#:

using var pdf = Pdf.FromMarkdown("# Report\n\nFindings are summarized below.");
pdf.Save("report.pdf");

Python Signature:

Pdf.from_markdown(
    content: str,
    title: str | None = None,
    author: str | None = None
) -> Pdf

PdfBuilder::new().from_markdown(content) (Builder Pattern)

Use PdfBuilder when you need control over page size, margins, font size, or metadata.

Rust:

use pdf_oxide::api::PdfBuilder;
use pdf_oxide::writer::PageSize;

let pdf = PdfBuilder::new()
    .title("Quarterly Report")
    .author("Finance Team")
    .page_size(PageSize::A4)
    .margin(54.0)           // 0.75 inch margins
    .font_size(11.0)
    .line_height(1.6)
    .from_markdown("# Q4 Report\n\n## Revenue\n\nRevenue grew **12%** year-over-year.")?;

pdf.save("quarterly.pdf")?;

Advanced Examples

Multi-Section Document

use pdf_oxide::api::Pdf;

let markdown = r#"
# Annual Report 2025

## Executive Summary

The company achieved **record growth** in all key metrics.

## Financial Highlights

- Revenue: $142M (+18%)
- Net Income: $31M (+24%)
- Operating Margin: 21.8%

## Strategic Priorities

1. Expand international presence
2. Launch next-generation platform
3. Invest in R&D capabilities

### Timeline

> Phase 1 launches in Q2, with full rollout expected by Q4.

## Technical Appendix

```json
{
  "version": "2.1.0",
  "release_date": "2025-03-15"
}

"#;

let pdf = Pdf::from_markdown(markdown)?; pdf.save(“annual_report.pdf”)?;


### Python with Metadata

```python
from pdf_oxide import Pdf

content = """
# Meeting Notes

## Attendees

- Alice (Engineering)
- Bob (Product)
- Carol (Design)

## Action Items

1. **Alice**: Complete API review by Friday
2. **Bob**: Update roadmap with new timeline
3. **Carol**: Share mockups for dashboard redesign
"""

pdf = Pdf.from_markdown(content, title="Meeting Notes", author="Alice")
pdf.save("meeting_notes.pdf")

Reading Markdown from a File

from pdf_oxide import Pdf

with open("README.md") as f:
    content = f.read()

pdf = Pdf.from_markdown(content, title="README")
pdf.save("readme.pdf")
import { WasmPdf } from "pdf-oxide-wasm";
import { readFileSync, writeFileSync } from "fs";

const content = readFileSync("README.md", "utf-8");
const pdf = WasmPdf.fromMarkdown(content);
writeFileSync("readme.pdf", pdf.toBytes());
use pdf_oxide::api::Pdf;

let content = std::fs::read_to_string("README.md")?;
let pdf = Pdf::from_markdown(&content)?;
pdf.save("readme.pdf")?;