Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

examples

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
csharp
csharp
 
 
go
go
 
 
java/01-extract-text
java/01-extract-text
 
 
javascript
javascript
 
 
php/01-extract-text
php/01-extract-text
 
 
python
python
 
 
ruby/01-extract-text
ruby/01-extract-text
 
 
rust
rust
 
 
wasm_node
wasm_node
 
 
README.md
README.md
 
 
cornercase_runner.rs
cornercase_runner.rs
 
 
create_pdf_from_markdown.rs
create_pdf_from_markdown.rs
 
 
create_pdf_with_custom_font.rs
create_pdf_with_custom_font.rs
 
 
create_pdf_with_images.rs
create_pdf_with_images.rs
 
 
dump_all_formats.rs
dump_all_formats.rs
 
 
edit_existing_pdf.rs
edit_existing_pdf.rs
 
 
edit_text_content.rs
edit_text_content.rs
 
 
extract_html_simple.rs
extract_html_simple.rs
 
 
extract_markdown_simple.rs
extract_markdown_simple.rs
 
 
extract_pages.rs
extract_pages.rs
 
 
extract_structured.rs
extract_structured.rs
 
 
extract_text_simple.rs
extract_text_simple.rs
 
 
html_to_pdf.rs
html_to_pdf.rs
 
 
html_to_pdf_arg.rs
html_to_pdf_arg.rs
 
 
ocr_example.py
ocr_example.py
 
 
ocr_scanned_pdf.rs
ocr_scanned_pdf.rs
 
 
python_example.py
python_example.py
 
 
qual_check.rs
qual_check.rs
 
 
render_page_simple.rs
render_page_simple.rs
 
 
render_pages.rs
render_pages.rs
 
 

README.md

pdf_oxide Examples

Runnable examples demonstrating pdf_oxide across every supported language. The core scenarios (01–07) are mirrored in each language and exercised in CI on Linux, macOS, and Windows; the 09-new-features showcases run on Linux.

Layout

examples/
  rust/        01..08 + 09-new-features/   (also registered as cargo --example targets)
  python/      01..08 + 09-new-features/
  javascript/  01..08 + 09-new-features/
  go/          01..08 + 09-new-features/
  csharp/      01..08 + 09-new-features/
  java/        01..07                      (core scenarios)
  ruby/        01..07                      (core scenarios)
  php/         01..07                      (core scenarios)
  wasm_node/   extract_text.mjs            (WASM on a Node host)

Core scenarios (01–07)

# Scenario What it shows
01 extract-text open a PDF, page count, per-page text
02 convert-formats page → Markdown / HTML / plain text
03 create-pdf build a PDF from Markdown/HTML/text
04 search-text full-text search across pages
05 extract-structured words + bounding boxes, lines, tables
06 edit-document metadata edit, page delete, merge
07 forms-annotations extract form fields + annotations

08 (batch-processing) and the 09-new-features showcases (barcodes, signing, PDF/A & PDF/UA, encryption, image embedding, …) are demonstrated per language where supported.

Running

# Rust
cargo run --example tutorial_extract_text -- tests/fixtures/simple.pdf

# Python
cd examples/python/01-extract-text && python main.py ../../../tests/fixtures/simple.pdf

# Node.js
node examples/javascript/01-extract-text/index.js tests/fixtures/simple.pdf

# Go
cd examples/go/01-extract-text && go run main.go ../../../tests/fixtures/simple.pdf

# C#
dotnet run --project examples/csharp/01-extract-text/ExtractText.csproj -- tests/fixtures/simple.pdf

Documentation

License

All examples are licensed under MIT OR Apache-2.0, same as the main library.