A powerful Node.js package for generating PDF documents with custom text formatting using simple markup syntax. Create PDFs with bold text, italic text, custom font sizes, colors, and more using an intuitive markup language.
- 🎨 Custom text formatting (bold, italic, font sizes, colors)
- 📄 Custom page sizes and dimensions
- 🔤 Support for custom fonts
- ⚙️ Flexible configuration options
- 📝 Simple markup syntax
- 🚀 TypeScript support
- 📦 Zero external dependencies for basic usage
npm install pdf-markupimport { generatePdf } from 'pdf-markup';
const options = {
text: `
Welcome to <b>PDF Markup</b>!
This text is <i>italic</i> and this is <b>bold</b>.
<24>Large heading text</24>
<#FF0000>This text is red</#> and <#0000FF>this is blue</#>.
Normal text with default formatting.
`
};
generatePdf(options)
.then(filePath => {
console.log(`PDF generated: ${filePath}`);
})
.catch(error => {
console.error('Error generating PDF:', error);
});const { generatePdf } = require('pdf-markup');
const options = {
text: `
Welcome to <b>PDF Markup</b>!
This text is <i>italic</i> and this is <b>bold</b>.
<24>Large heading text</24>
<#FF0000>This text is red</#> and <#0000FF>this is blue</#>.
Normal text with default formatting.
`
};
generatePdf(options)
.then(filePath => {
console.log(`PDF generated: ${filePath}`);
})
.catch(error => {
console.error('Error generating PDF:', error);
});The generatePdf function accepts only the text content:
interface GeneratePdfOptions {
text: string; // The markup text to render
}All other configuration is handled through the configuration file.
Create a pdf-markup.config.js or pdf-markup.config.json file in your project root:
pdf-markup.config.js
module.exports = {
pageSize: [595, 842], // A4 format [width, height] in points
fontSize: 12, // Base font size in points
lineHeight: 18, // Line height in pixels
color: { hex: '#000000' }, // Default text color
margin: {
top: 72, // Top margin in points (1 inch)
left: 54 // Left margin in points (0.75 inch)
},
outputDir: './pdfs',
documentName: 'document.pdf',
fontPaths: {
normal: './fonts/Roboto-Regular.ttf',
bold: './fonts/Roboto-Bold.ttf',
italic: './fonts/Roboto-Italic.ttf',
boldItalic: './fonts/Roboto-BoldItalic.ttf'
}
};pdf-markup.config.json
{
"pageSize": [595, 842],
"fontSize": 12,
"lineHeight": 18,
"color": { "hex": "#000000" },
"margin": {
"top": 72,
"left": 54
},
"outputDir": "./pdfs",
"documentName": "document.pdf",
"fontPaths": {
"normal": "./fonts/Roboto-Regular.ttf",
"bold": "./fonts/Roboto-Bold.ttf",
"italic": "./fonts/Roboto-Italic.ttf",
"boldItalic": "./fonts/Roboto-BoldItalic.ttf"
}
}interface PdfConfig {
pageSize?: [number, number]; // Page dimensions [width, height] in points
fontSize?: number; // Base font size in points
lineHeight?: number; // Line height in pixels
fontPaths?: {
normal?: string; // Path to regular font file
bold?: string; // Path to bold font file
italic?: string; // Path to italic font file
boldItalic?: string; // Path to bold italic font file
};
color?: PdfColor; // Default text color
margin?: {
top: number; // Top margin in points
left: number; // Left margin in points
};
documentName?: string; // Output PDF filename
outputDir?: string; // Output directory path
}
type PdfColor = {
rgb: {
r: number; // Red component (0-255)
g: number; // Green component (0-255)
b: number; // Blue component (0-255)
};
} | {
hex: string; // Hex color format (e.g., "#FF0000")
};Custom fonts are configured in the configuration file, not as runtime options:
// pdf-markup.config.js
module.exports = {
fontPaths: {
normal: './fonts/MyFont-Regular.ttf',
bold: './fonts/MyFont-Bold.ttf',
italic: './fonts/MyFont-Italic.ttf',
boldItalic: './fonts/MyFont-BoldItalic.ttf'
},
// other config options...
};The package includes default Roboto fonts, but you can override them by providing custom font paths in the configuration file. The font loading is handled automatically by the fonts.ts module.
| Tag | Description | Example |
|---|---|---|
<b>text</b> |
Bold text | <b>Bold text</b> |
<i>text</i> |
Italic text | <i>Italic text</i> |
<size>text</size> |
Custom font size | <24>Large text</24> |
<#COLOR>text</#> |
Custom text color | <#FF0000>Red text</#> |
Colors should be specified in hexadecimal format without the # symbol in the closing tag:
<#FF0000>Red text</#><#00FF00>Green text</#><#0000FF>Blue text</#><#FFFF00>Yellow text</#>
Font sizes are specified in points:
<12>Small text</12><18>Medium text</18><24>Large text</24><36>Extra large text</36>
Page sizes are specified as arrays of [width, height] in points (72 points = 1 inch):
[595, 842]- A4 format (default)[612, 792]- Letter format[842, 1191]- A3 format[420, 595]- A5 format
Only top and left margins are supported, specified in points:
margin: {
top: 72, // 1 inch from top
left: 54 // 0.75 inch from left
}Line height is specified in pixels (not as a multiplier):
14- Tight spacing18- Normal spacing (default)24- Loose spacing
Colors can be specified in two formats:
Hex format:
color: { hex: '#FF0000' }RGB format:
color: {
rgb: {
r: 255,
g: 0,
b: 0
}
}The generatePdf function returns a Promise that resolves to the full file path of the generated PDF:
generatePdf({ text: 'Hello World!' }).then(filePath => {
console.log(`PDF saved to: ${filePath}`);
// Example output: "/path/to/project/pdfs/document.pdf"
});const complexText = `
<24><b>Document Title</b></24>
This is a paragraph with <b>bold</b> and <i>italic</i> text.
<18><#FF0000>Warning: Important Information</#></18>
<#0000FF>Blue text</#> with normal formatting continues here.
<12>Small print text at the bottom</12>
`;
generatePdf({ text: complexText });const documents = [
{ content: 'Content for document 1' },
{ content: 'Content for document 2' },
];
Promise.all(
documents.map(doc => generatePdf({ text: doc.content }))
).then(filePaths => {
console.log('All documents generated:', filePaths);
});Generates a PDF document with the specified text content and returns the file path.
Parameters:
options.text- The markup text to render
Returns: Promise that resolves to the full file path of the generated PDF.
Parses markup text and returns an array of text fragments with formatting information.
Parameters:
line- A single line of text with markup tags
Returns: Array of TextFragment objects containing text and formatting data.
type TextFragment = {
text: string;
bold?: boolean;
italic?: boolean;
fontSize?: number;
color?: {
r: number;
g: number;
b: number;
};
};try {
const filePath = await generatePdf({ text: 'Hello World!' });
console.log('Success:', filePath);
} catch (error) {
console.error('PDF generation failed:', error);
}- Node.js 14.0 or higher
- Supports both CommonJS and ES modules
MIT License
Copyright (c) 2024
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.
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
If you encounter any issues or have questions, please file an issue on the GitHub repository.
[Npmjs](https://www.npmjs.com/package/pdf-markup)