Skip to content

Commit c26926e

Browse files
committed
Expand Webifier extension documentation
1 parent 6f3d936 commit c26926e

10 files changed

Lines changed: 800 additions & 48 deletions

File tree

configurations/config.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ webifier:
66
uses: webifier.markdown
77
notebook:
88
uses: webifier.notebook
9+
pdf:
10+
uses: webifier.pdf
911
theme:
1012
uses: webifier.theme
1113
switcher: true
@@ -75,6 +77,8 @@ page_navigation:
7577
href: /pages/user-guide/extensions/02-markdown.html
7678
- title: Notebook Extension
7779
href: /pages/user-guide/extensions/03-notebook.html
80+
- title: PDF Extension
81+
href: /pages/user-guide/extensions/11-pdf.html
7882
- title: Chapters Extension
7983
href: /pages/user-guide/extensions/04-chapters.html
8084
- title: People Extension

pages/user-guide/04-content-files.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,20 @@ Local HTML and PDF links can be copied or rendered depending on how they are
6767
referenced. Local images and assets used by Markdown or HTML are copied into the
6868
output so the generated site remains self-contained.
6969

70+
Use `pdf=...` with `webifier.pdf` enabled when you want the PDF to live inside a
71+
normal Webifier page with navigation, comments, open/download links, and a
72+
site-styled frame:
73+
74+
```markdown
75+
[Read the report](pdf=reports/index.pdf)
76+
```
77+
78+
Put `metadata.yml` beside the PDF to control the generated page title:
79+
80+
```yaml
81+
title: Final Report
82+
metadata:
83+
description: Embedded PDF report.
84+
```
85+
7086
For more detail, see [Processing Pipeline](reference/05-processing-pipeline.html).

0 commit comments

Comments
 (0)