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.

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

Improve documentation on templates #356

Closed
koosvanderkolk opened this issue Mar 14, 2024 · 2 comments
Closed

Improve documentation on templates #356

koosvanderkolk opened this issue Mar 14, 2024 · 2 comments

Comments

@koosvanderkolk
Copy link

koosvanderkolk commented Mar 14, 2024

Thanks for the great module, checking it out.

I think the documentation on "Writing templates" can be improved.

For me, I just wanted to know what the docx template would look like for e.g.

 const report = await createReport({
    template,
    data: { name: 'John', surname: 'Appleseed' },
    cmdDelimiter: ['{', '}'],
  });

It is just:

{name}
{surname}

It would be great if this is just documented, instead of a referral to an example.

@juw177
Copy link

juw177 commented Mar 19, 2024

Just want to say that I had the same experience having just come across this project, looked through the node examples folder and could not find one example that would simply show John Appleseed.

@jjhbw
Copy link
Collaborator

jjhbw commented Mar 20, 2024

Good points! I have simplified the docs based on your suggestions. ac2e4ae

@jjhbw jjhbw closed this as completed Mar 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants