ProtectedcodeCode generator for generating DOCX paragraphs from AST nodes.
ProtectedsummaryMarkdown parser instance used for parsing summary fields.
ProtectedshowCheck whether to show icons in the document.
Whether to show icons
ProtectedshowWhether to show raw URLs or hide them behind reasonable text.
ProtectedbuildBuild the document children paragraphs.
Array of paragraphs for the document
ProtectedcreateCreate a text paragraph with a bold label prefix and normal value suffix.
The bold label text (e.g., "Keywords: ")
The normal value text
A DOCX paragraph with mixed bold/normal text
ProtectedcreateCreate a detail line paragraph (italicized).
The text content
A DOCX paragraph with italic styling
ProtectedcreateCreate a Document instance from the rendered sections.
A DOCX Document instance
ProtectedcreateConvert a markdown string to DOCX paragraphs.
This method parses markdown content and converts it to appropriate DOCX paragraph elements, supporting:
The markdown string to convert
Array of DOCX paragraphs
ProtectedcreateCreate a section heading paragraph with horizontal rule.
The heading text
A DOCX paragraph with heading styling
ProtectedcreateCreate a subsection heading paragraph.
The heading text
A DOCX paragraph with subheading styling
ProtectedcreateCreate a normal text paragraph.
The text content
A DOCX paragraph
ProtectedcreateCreate a two-column layout paragraph with optional right-aligned content.
Uses a right-aligned tab stop to push the right content to the margin. Both left and right content can contain TextRun or ExternalHyperlink nodes.
Array of TextRun or ExternalHyperlink for the left column
OptionalrightContent: (TextRun | ExternalHyperlink)[]
Optional array of TextRun or ExternalHyperlink for the right column
Optionalspacing: { after?: number; line?: number }
Optional spacing configuration for the paragraph
OptionaltabSize: numberA DOCX paragraph with two-column layout
ProtectedgetGet the base font size in half-points from typography settings.
Font size in half-points
ProtectedgetGet the font family from typography settings.
Font family name or undefined for default
ProtectedgetGet the line spacing in twips from typography settings.
Line spacing value
ProtectedgetGet the line spacing name from typography settings.
Line spacing option name
ProtectedgetGet page margins from layout settings.
Page margins in twips
ProtectedgetGet the paper size dimensions in twips for the document.
DOCX page dimensions are specified in twips (1/20 of a point).
Paper size dimensions
ProtectedgetGet scaled font size based on base font size.
Scale factor (e.g., 2 for title = 2x base size)
Scaled font size in half-points
ProtectedgetCheck whether to show page numbers.
Whether to show page numbers
ProtectedjoinJoin multiple rendered sections into a single output.
The sections to join
The joined sections
Render the resume as a DOCX Uint8Array.
A promise that resolves to the DOCX data
Create paragraphs for the awards section.
Array of DOCX paragraphs for awards
Create paragraphs for the basics section.
Renders name and headline inline, similar to moderncv-calm LaTeX template.
Array of DOCX paragraphs for basics
Create paragraphs for the certificates section.
Array of DOCX paragraphs for certificates
Render the resume as a DOCX Blob.
A promise that resolves to the DOCX Blob
Create paragraphs for the education section.
Uses two-column layout: institution left, URL right.
Array of DOCX paragraphs for education
Create paragraphs for the interests section.
Array of DOCX paragraphs for interests
Create paragraphs for the languages section.
Array of DOCX paragraphs for languages
Create paragraphs for the location section.
Array of DOCX paragraphs for location
ProtectedrenderRender sections in the specified order.
The rendered sections in the specified order
Render the preamble of the resume.
Empty array as DOCX handled within Document directly
Create paragraphs for the profiles section.
Array of DOCX paragraphs for profiles
Create paragraphs for the projects section.
Array of DOCX paragraphs for projects
Create paragraphs for the publications section.
Array of DOCX paragraphs for publications
Create paragraphs for the references section.
Array of DOCX paragraphs for references
Create paragraphs for the skills section.
Array of DOCX paragraphs for skills
Create paragraphs for the summary section.
Array of DOCX paragraphs for summary
Create paragraphs for the volunteer section.
Array of DOCX paragraphs for volunteer
Create paragraphs for the work section.
Uses two-column layout: position/company left, dates right.
Array of DOCX paragraphs for work
MIT License
Copyright (c) 2023–Present PPResume (https://ppresume.com)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.