Skip to content

Polypane/snippets

Repository files navigation

Polypane Snippets

A community-powered collection of snippets for the Polypane snippets panel, available from the Polypane Snippets store.

Contributing

To contribute, fork this repository, add your snippet to the snippets folder, and submit a pull request. Please ensure that your snippet includes a clear description. You can submit individual snippets or a single JSON file with a collection of snippets.

Snippets can be exported from Polypane directly. These don't include author, folder description or categories, so make sure to add those manually to your contribution.

PRs will be evaluated on a case-to-case basis. If you are unsure about your snippet, please first create an issue.

Validating snippets

PRs can only be merged if the newly added snippets or collections follow the correct JSON schema (both can be validated against the same schema). Added snippets are automatically checked when you open a PR, but you can also validate your snippets locally before submitting a PR:

npm install
npm run validate -- snippets/lang\ outliner.json

The validator exits with code 0 for valid input. For invalid input, it exits with code 1 and prints the validation issues.

For more information on the validator script, you can run

npm run help

The validator script additionally checks if the snippets content is encoded correctly and will flag snippets that are encoded as bookmarklets directly. Snippets should not start with javascript: or be URL encoded.

If you want to clean these up quickly, import them into the Polypane snippets panel and export them again, which will fix the encoding.

License

This project is licensed under the Apache License 2.0.

About

A community-powered collection of snippets for the Polypane snippets panel

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors