https://github.com/stritt/params
The content on your site, powered by your URL.
https://github.com/stritt/params
Last synced: 7 months ago
JSON representation
The content on your site, powered by your URL.
- Host: GitHub
- URL: https://github.com/stritt/params
- Owner: stritt
- License: mit
- Created: 2023-09-10T06:35:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-09-11T01:54:36.000Z (almost 3 years ago)
- Last Synced: 2025-03-17T09:08:54.667Z (about 1 year ago)
- Language: JavaScript
- Homepage: https://params.org
- Size: 6.84 KB
- Stars: 22
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Params
Control your website content using query parameters.
## Installation
Add `Params` to your project using npm:
```bash
npm install @burcs/params
```
Or, embed the script directly on your website.
## Quick Start
`Params` is designed for ease of use. Modify content based on the order of site elements. For example, to alter the second paragraph on a page:
```html
https://params.org/page?p_2=updated+content+here
```
## Party Mode 🎉
Activate "Party Mode" to effortlessly update your site. By enabling this mode, you can edit your page content in-line. Try it out:
```html
https://params.org/page?party=true
```
Make your changes, enjoy the party!
## Supported Elements
Currently, `Params` supports:
- Headings: `h1`, `h2`, `h3`, `h4`, `h5`, `h6`
- Text & Styling: `p`, `i`, `b`, `span`
- Lists: `ul`, `ol`
- Media: `img`
More elements are in the pipeline.
## Styling on the Fly
Change element styles by invoking different CSS classes:
```html
https://params.org/page?p_2_class=class-name
```
This feature works well with libraries like TailwindCSS.
## Security
Image sources are limited to whitelisted domains to prevent malicious code injections.
## Contribute
`Params` is open-source. Submit a PR if you have suggestions or improvements.
## License
MIT License.