Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/llewellynvdm/preupver
The easy pre tag updater for include statments.
https://github.com/llewellynvdm/preupver
Last synced: about 1 month ago
JSON representation
The easy pre tag updater for include statments.
- Host: GitHub
- URL: https://github.com/llewellynvdm/preupver
- Owner: Llewellynvdm
- License: mit
- Created: 2023-11-28T06:52:05.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-28T08:43:05.000Z (about 1 year ago)
- Last Synced: 2024-03-15T15:21:42.347Z (10 months ago)
- Language: JavaScript
- Homepage: https://git.vdm.dev/Llewellyn/PreUpVer
- Size: 36.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PreUpVer Library
## Introduction
PreUpVer is a versatile JavaScript library designed to automatically update the version numbers of library scripts in your documentation. It identifies specific `
` tags on your webpage and updates them with the latest version tag fetched from a specified repository, ensuring your documentation always displays up-to-date information.
## Installation
To use PreUpVer in your project, include the minified library in the header of your HTML page:
```html
```
## How It Works
PreUpVer operates by searching for `
` tags with a designated class (`preupver`) and using their data attributes to perform version updates. It simplifies the process of keeping your library references up-to-date in documentation.
### Automatic Detection and Updating
When the webpage loads, PreUpVer finds all `
` tags marked with the `preupver` class. It then extracts necessary details from their data attributes and updates each tag with the latest library version.
### Usage
1. **Marking `
` Tags:**
Add the `class="preupver"` to `
` tags in your HTML and define the required data attributes for automatic updating:
```html
```
Replace `unique-id`, `username`, `library`, and other placeholders with your specific details.
2. **Attributes Explained:**
- `id`: A unique identifier for the `
` tag.
- `data-api-url`: The API URL to fetch the latest library version.
- `data-description`: A brief description of the library script.
- `data-url`: The URL of the script, where `${version}` will be replaced with the latest version number.
### Example
Check out the [tests](https://git.vdm.dev/Llewellyn/PreUpVer/src/branch/master/tests/) folder for the examples we use to test if this library works as expected.
## Advanced Usage
For more advanced scenarios, PreUpVer also provides `TargetLibrary` and `IncludeVersionUpdater` classes, which can be used to manually configure and update `
` tags. This is particularly useful for custom implementations or testing purposes.
### Manual Configuration
You can manually create instances of `TargetLibrary` and `IncludeVersionUpdater` for specific `
` tags. Refer to the `/tests` directory in the repository for examples and test cases.
## Contributing
We welcome contributions to PreUpVer. Please refer to the repository's contribution guidelines for more information on how to contribute.
## License
PreUpVer is open-source software licensed under the [MIT license](https://git.vdm.dev/Llewellyn/PreUpVer/src/branch/master/LICENSE.md).