Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the 'keepOriginalStyles' options #2549

Merged
merged 2 commits into from
May 20, 2024
Merged

Document the 'keepOriginalStyles' options #2549

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7ee5f95
Document the 'keepOriginalStyles' options
younesspotmaster Jan 17, 2024
6947902
Merge branch 'master' into patch-2
dolanmiu Apr 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/usage/patcher.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ interface Patch {
| type | `PatchType` | Required | `DOCUMENT`, `PARAGRAPH` |
| children | `FileChild[] or ParagraphChild[]` | Required | The contents to replace with. A `FileChild` is a `Paragraph` or `Table`, whereas a `ParagraphChild` is typical `Paragraph` children. |


The patcher also takes in a `keepOriginalStyles` boolean, which will preserve the styles of the patched text when set to true.

### How to patch existing document

1. Open your existing word document in your favorite Word Processor
Expand Down