Tool to develop bookmarklets
Project description
Bookmarklets
A tool for developing bookmarklets.
Inspired by https://github.com/mrcoles/bookmarklet, but designed to support multiple bookmarklets, and to also export as html.
Develop bookmarklets based on javascript files, eg. so that you can commit the source files to git.
Installation
It is recommended to install using pipx
, but you can also use pip
. See https://pypi.org/project/pipx/.
pipx install bookmarklet
To convert them to bookmarklets, either start the server or generate a bookmarks.html file.
Server
- run
bookmarklet server [FOLDER]
- specify the folder with the javascript files, otherwise the current folder is used
- use
-o
/--open
to automatically open the webpage - use
-p
/--port
to serve the port other than the default (8000) - use
--public
to allow other devices on your network to access the page, otherwise only on localhost
- on the webpage drag each bookmarklet to your bookmarks bar
HTML
- run
bookmarklet html [FOLDER]
- specify the folder with the javascript files, otherwise the current folder is used
- use
-o
/--output
to specify the output file, otherwise it defaults tobookmarks.html
- import the
bookmarks.html
into your browser
Metadata
You can include some metadata in a comment block at the top of the source file.
The fields that you can use are:
- name: the name of the bookmarklet (if not provided, the file name will be used)
- in the server this will be the name of the button
- in the html this will be the name of the bookmark, and included in a comment
- author : the author of the bookmarklet
- in the server this will be mentioned next to the button
- in the html this will be included in a comment
- url: link to the author
- in the server this will be linked to the author
- in the html this will be included in a comment
- script: script to load before running the bookmarklet
- specify it multiple times to use multiple scripts
- style: style to load before running the bookmarklet
- specify it multiple times to use multiple styles
See the examples in this repo.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
bookmarklets-0.3.0.tar.gz
(5.0 kB
view hashes)
Built Distribution
Close
Hashes for bookmarklets-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b47f506871515666998f819fc84483caa5df78d3f007ee4bdb5362b1f7411004 |
|
MD5 | b8edb4fb3fa4655ab8a7e20dc910f6ca |
|
BLAKE2b-256 | d81aa70c485c95ad3a85fa7c75483bf1f9b6e9e28bc25ea8a8c551bf93af8d26 |