weweb-scripttag
v1.0.0
Published
Easily connect weweb to scripttag
Downloads
3
Readme
Weweb ScriptTag Embedder
Adding To Weweb
- Open Weweb
- Click on the puzzle piece icon
- Click "Plugins"
- Click "NPM"
- Search for
scripttag
- Click Plus - you're done!
Adding any Embed to your site
- Create any element
- Give it a class of "scripttag"
- Go to custom attributes and give it a "scripttag-src" of your target URL
- Watch it appear on your page!
Useful Scripts
yarn build
will build using typescript pre-configured to node-compatible defaultsyarn docs
will auto-generate a README.md that starts with TOP.md, then adds CLI documentation (via commanderdoc) for any tool you have set up, and then library documentation after that.yarn test
is pre-configured to test for typescript errorsyarn watch
will watch the codebase for changes and rebuild (using livelink)
Git code protections
git commit
will be blocked on themain
branch unless you set the environment variableALLOWMAIN=1
Branch commits and PRs are thus encouragedgit commit
also tests messages for meeting the commitline standard conventions.git commit
blocks pushes that do not passyarn test
(as a base case, they must pass typescript compilation)npm publish
will always rebuild the code, the documentation, and push those changes back to the repository.npm publish
will only publish the lib and src directories - any others are no
A note on "main"
I made a deliberate choice to change the primary branch from master
to main
for reasons that are obvious to some. This repository endeavors to make that just automatic.
PRs and feedback welcome via GitHub issues.
Usage
npx template [options]
template - v1.0.0