Skip to content

Docs: Adding the forms.md to the documentation #1172

@bjbk

Description

@bjbk

It took me some time to find in the documentation how to implement the Forms in PDFKit. Seems the official documentation does not seem to include the forms.md file in the generate.js and the generate_website.js files.

I was thinking of doing a PR but for such a trivial change, wasn't sure if there may be a reason why the team didn't include this file in the documentation.

// generate.js
// render all sections of the guide and write the pdf file
const doc = new PDFDocument();
doc.pipe(fs.createWriteStream('guide.pdf'));
renderTitlePage(doc);
render(doc, 'getting_started.md');
render(doc, 'paper_sizes.md');
render(doc, 'vector.md');
render(doc, 'text.md');
render(doc, 'images.md');
render(doc, 'outline.md');
// perhaps here:
render(doc, 'forms.md');
render(doc, 'annotations.md');
render(doc, 'destinations.md');
render(doc, 'you_made_it.md');
doc.end();

And in the generate_website.js file add to the files array:

const files = [
  '../README.md',
  'getting_started.md',
  'paper_sizes.md',
  'vector.md',
  'text.md',
  'images.md',
  'outline.md',
  // again here
  'forms.md', 
  'annotations.md',
  'destinations.md',
  'you_made_it.md'
];

If I should do a PR for this, I'll be happy to do so.

Cheers!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions