Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qownnotes/scripts
QOwnNotes script repository
https://github.com/qownnotes/scripts
javascript note-taking qml qownnotes script
Last synced: 3 months ago
JSON representation
QOwnNotes script repository
- Host: GitHub
- URL: https://github.com/qownnotes/scripts
- Owner: qownnotes
- License: gpl-3.0
- Created: 2017-05-15T12:52:23.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-05-22T08:18:11.000Z (9 months ago)
- Last Synced: 2024-05-22T13:31:27.996Z (9 months ago)
- Topics: javascript, note-taking, qml, qownnotes, script
- Language: QML
- Homepage: http://www.qownnotes.org
- Size: 896 KB
- Stars: 97
- Watchers: 6
- Forks: 71
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# QOwnNotes script repository
[Installation](http://www.qownnotes.org/installation) |
[Changelog](https://github.com/pbek/QOwnNotes/blob/develop/CHANGELOG.md) |
[Issues](https://github.com/qownnotes/scripts/issues) |
[Releases](https://github.com/pbek/QOwnNotes/releases) |
[Documentation](http://docs.qownnotes.org) |
[IRC Chat](https://kiwiirc.com/client/irc.freenode.net/#qownnotes) |
[Gitter Chat](https://gitter.im/qownnotes/qownnotes)
[](https://github.com/qownnotes/scripts/actions)
[](https://travis-ci.org/qownnotes/scripts)
[](https://gitter.im/qownnotes/qownnotes)
Here you will find the scripts you can directly access in [QOwnNotes](http://www.qownnotes.org), the plain-text file notepad with markdown support and Nextcloud and ownCloud integration.
Please visit the [Scripting documentation](https://docs.qownnotes.org/en/latest/scripting/) for more information about scripting and how to write your own.
## Contributing
To bring your script into the **script repository** you just have to do the following:
- **[fork](https://help.github.com/articles/fork-a-repo/)** the repository on GitHub
- checkout your forked repository with `git clone https://github.com/YOUR_GITHUB_NAME/scripts.git qownnotes-scripts`
- **duplicate** the **`example-script` folder** and give it a more descriptive name
- **add your script** to the folder and remove the `example-script.qml`
- **edit** the **`info.json`** to add your meta data and describe what your script is doing
- you can use [example script info.json](https://jsoneditoronline.org/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fqownnotes%2Fscripts%2Fmaster%2Fexample-script%2Finfo.json) to help you with the json encoding
- if you are not sure which `minAppVersion` the commands you are using needs take the [current version](https://github.com/pbek/QOwnNotes/blob/master/src/version.h) of *QOwnNotes*
- **commit and push** your changes to your repository
- create a **[pull request](https://help.github.com/articles/creating-a-pull-request/)** to get your script merged into the QOwnNotes script repository
### Editing an existing script in the GitHub web interface
When editing an existing script in the GitHub web interface, do the following:
- If you do not already have a fork:
- Go to .
- Click the **Fork** button in the upper right of the screen (between **Watch** and **Star**).
- Leave the defaults (recommended) and click the **Create Fork** button.
- In your fork, select the QML file to edit.
- Make any desired changes.
- Fill out the Commit changes fields.
- If this is a personal fork, select 'Commit directly to master branch'.
- Click **Commit changes** button.
- Select the associated `info.json` (it will be in the same folder).
- Add your name as an author.
- Increase the version number.
- Ensure the `minAppVersion` reflects the correct version needed (if using new features).
- Make any other changes.
- Fill out the Commit changes fields.
- If this is a personal fork, select 'Commit directly to master branch'.
- Click **Commit changes** button.
- Create a pull request to qownnotes/scripts on the master branch.