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

update render command documentation to include a note on installation #497

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

pradeeproark
Copy link

The render command is one of the few exceptions that require the inclusion of an additional script file from the distribution to work. This doc update makes it clearer by mentioning that. as discussed in #496

@nicobako
Copy link
Contributor

nicobako commented Dec 7, 2023

This is great! I used this suggestion to help resolve the exact same issue, and it worked like a charm. Thanks @pradeeproark .

### Installing

Note: if you want the template command, you must include the /dist/template.js file in addition to the hyperscript script
~~~ html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest using ```html instead, which is in line with how html code blocks are written in other places in this file.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for checking @nicobako . I picked the syntax above for referencing the script from

~~~ html
. And it renders it like same when building and testing the docs locally.

Screenshot 2023-12-16 at 14 51 36

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.

None yet

2 participants