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

📝 Provide accessible examples #63

Merged
merged 1 commit into from
Oct 2, 2023
Merged

📝 Provide accessible examples #63

merged 1 commit into from
Oct 2, 2023

Conversation

ralfstx
Copy link
Member

@ralfstx ralfstx commented Oct 2, 2023

The example folder contained only a single example named sample.js. This file was used to check certain conditions during development, but was not comprehensible to users. To make the examples more accessible, this commit replaces this file with multiple individual examples for different topics.

A README file is added to the examples folder to explain how to run the examples. A script is provided to download the required fonts. This is clearer than extracting TTF fonts from WOFF files in npm packages. It is also closer to an actual usage of the library.

The npm start magic is removed. All runtime environments support a --watch flag that can be used to re-create the PDF files when the source files change.

The example folder contained only a single example named `sample.js`.
This file was used to check certain conditions during development, but
was not comprehensible to users. To make the examples more accessible,
this commit replaces this file with multiple individual examples for
different topics.

A README file is added to the examples folder to explain how to run the
examples. A script is provided to download the required fonts. This is
clearer than extracting TTF fonts from WOFF files in npm packages. It is
also closer to an actual usage of the library.

The `npm start` magic is removed. All runtime environments support a
`--watch` flag that can be used to re-create the PDF files when the
source files change.
@ralfstx ralfstx merged commit da09e7b into main Oct 2, 2023
1 check passed
@ralfstx ralfstx deleted the examples branch October 2, 2023 22:38
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

Successfully merging this pull request may close these issues.

1 participant