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

Build a PDF or HTML helpfile at startup from the Markdown source #78

Open
iansan5653 opened this issue Sep 12, 2022 · 1 comment
Open
Labels
enhancement New feature or request

Comments

@iansan5653
Copy link
Owner

When I wrote the manual, I intentionally didn't include the PDF version in the source code so that we would have a single copy of the file in the repository. This is a bit confusing though since when you run the code locally, the "Help" button is broken.

Instead, I think a better strategy would be to build an HTML file on startup and link to that instead.

@iansan5653 iansan5653 self-assigned this Sep 12, 2022
@gutow
Copy link
Contributor

gutow commented Sep 13, 2022

There are certainly fewer issues with converting the markdown to html. Startup may be a bad time to do that as modifying an application bundle on the fly is likely to raise security flags in the future. I find it better to generate files immediately after updates.

I also do not think it is a bad idea to include the file in the VCS. Building documentation is usually one of the last steps before a release and the documentation should be under VCS.

My 2p.

@iansan5653 iansan5653 changed the title The PDF help file is not accessible when running from source Build a PDF or HTML helpfile at startup from the Markdown source Sep 19, 2022
@iansan5653 iansan5653 added the enhancement New feature or request label Sep 19, 2022
@iansan5653 iansan5653 removed their assignment Sep 19, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants