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

Extension docs: npm, bundler, min/unmin and SRI hash instructions #3078

Open
wants to merge 11 commits into
base: master
Choose a base branch
from

Conversation

marisst
Copy link
Contributor

@marisst marisst commented Dec 14, 2024

Pull request should be viewed together with the corresponding PR in htmx-extensions repository bigskysoftware/htmx-extensions#123.

Documentation is updated to elaborate on extension installation and integration. Until now, extension installation instructions were limited to a CDN script tag. This change adds:

  • guidance on installation with npm
  • guidance on integration with bundlers
  • instructions to access minified and unminified extension versions
  • SRI hash in CDN script tag installation example
  • links to newest extension versions which were released with the htmx.org@2.0.4 release
  • makes the need of hx-ext clearer Extensions documentation could make need for hx-ext clearer #2475

@marisst marisst changed the title Extension documentation: add npm/bundler installation guides and up versions Extension documentation: add npm/bundler installation and up versions Dec 14, 2024
@Telroshan Telroshan added the documentation Improvements or additions to documentation label Dec 15, 2024
@marisst marisst marked this pull request as draft December 15, 2024 08:36
@marisst
Copy link
Contributor Author

marisst commented Dec 15, 2024

@Telroshan please don't review it yet. I converted to draft. Unfortunately I realised it won't be as easy as this. When integrating an extension with import statement, we need to figure out how to inject htmx in the scope of the extension. I think we also need to update all extension package definitions to make htmx.org a required dependency. I will need to investigate how this is done in other JS libraries. If you have good examples let me know.

@Telroshan
Copy link
Collaborator

Don't worry @marisst , I'm terribly ignorant about this topic anyway so I will likely not be the one to review this 😆

@marisst marisst changed the title Extension documentation: add npm/bundler installation and up versions Update extension installation documentation: npm, esm, min Dec 19, 2024
@marisst marisst changed the title Update extension installation documentation: npm, esm, min Update extension installation documentation: npm, esm, min, sri hash Dec 19, 2024
@marisst marisst changed the title Update extension installation documentation: npm, esm, min, sri hash Extension installation documentation: add instructions for npm and bundlers, provide SRI hash Dec 19, 2024
@marisst marisst changed the title Extension installation documentation: add instructions for npm and bundlers, provide SRI hash Extension docs: add npm installation, bundler integration and SRI hash instructions Dec 19, 2024
@marisst marisst changed the title Extension docs: add npm installation, bundler integration and SRI hash instructions Extension docs: add npm, bundler and SRI hash instructions Dec 19, 2024
@marisst marisst marked this pull request as ready for review December 19, 2024 19:59
@marisst marisst changed the title Extension docs: add npm, bundler and SRI hash instructions Extension docs: add npm installation, bundler integration, min/unmin access and SRI hash instructions Dec 19, 2024
@marisst marisst changed the title Extension docs: add npm installation, bundler integration, min/unmin access and SRI hash instructions Extension docs: add npm, bundler, min/unmin version and SRI hash instructions Dec 19, 2024
@marisst marisst changed the title Extension docs: add npm, bundler, min/unmin version and SRI hash instructions Extension docs: npm, bundler, min/unmin version and SRI hash instructions Dec 19, 2024
@marisst marisst changed the title Extension docs: npm, bundler, min/unmin version and SRI hash instructions Extension docs: npm, bundler, min/unmin and SRI hash instructions Dec 20, 2024
@marisst
Copy link
Contributor Author

marisst commented Dec 20, 2024

@Telroshan Okay. It's all ready for review now. Do you know who are the most relevant reviewers for this type of change?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants