Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dynobo/noteto
Template Tool for the reMarkable tablet (and maybe others?)
https://github.com/dynobo/noteto
remarkable remarkable-tablet template
Last synced: about 1 month ago
JSON representation
Template Tool for the reMarkable tablet (and maybe others?)
- Host: GitHub
- URL: https://github.com/dynobo/noteto
- Owner: dynobo
- License: mit
- Created: 2021-03-03T08:32:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-12-25T19:28:59.000Z (11 months ago)
- Last Synced: 2024-08-02T15:31:45.510Z (3 months ago)
- Topics: remarkable, remarkable-tablet, template
- Language: JavaScript
- Homepage: https://noteto.needleinthehay.de/
- Size: 1.05 MB
- Stars: 58
- Watchers: 7
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# NoTeTo
Proof of Concept for a **No**tetaking **Te**mplate **To**ol for the reMarkable tablet.
Try it on ****.
## Introduction
This application was born from a specific need: I found [many useful templates](#template-resources) for my tablet, but none that included all the features I required. Supposly everyone has different needs, so I built this application for creating custom templates based on a building block principle.
**Features:**
1. Choose a template from the "Gallery" as starting point (or start on empty page)
2. Add predefined template elements ("blocks")
3. Move, resize and style the "blocks"
4. Adjust texts and labels
5. Export the template as `png`-image
6. Save as `json` to load it later for further adjusments
Copying the `png`-image to the tablet is *not* in the scope of NoTeTo. Use one of the available [tools for transferring templates to tablet](#transfer-tools).
## Contribute templates for the Gallery
**Via Pull Request (preferred):**
1. Create a nice template
2. "Download as PNG" as well as "Export to JSON"
3. Give both files _the_same_ meaningful name (all lower-case, hyphen separated)
4. Fork noteto-repo and put the two files in a new subfolder in [/js/gallery/](https://github.com/dynobo/noteto/tree/main/noteto/js/gallery) with the _same_name_ as your files.
5. Add a new object _at_the_end_ of the `templates`-Array in [`Gallery.js`](https://github.com/dynobo/noteto/blob/main/noteto/js/gallery/Gallery.js) with the appropriate information
6. Run NoTeTo locally (see section "Development & Contributing") as see if your template shows up as expected
7. Create a Pull Request.
**Via issue:**
1. Create a nice template
2. "Download as PNG" as well as "Export to JSON"
3. Give both files _the_same_ meaningful name (all lower-case, hyphen separated)
5. Open a ticket, upload both files along with the information to be shown in the Gallery:
- Template Name
- Contributor Name
- Short(!) description
## Development & contributing
The app should be considered as unstable, unfortunately I won't have much time to work on it. Contributions as pull requests are very welcome.
Development setup is kept minimal, no build is required:
1. Clone the repository
2. In the repositories root, start your favorite local webserver
3. Point your browser to the `index.html` on `localhost`
E.g., you can run:
```
git clone https://github.com/dynobo/noteto.git
cd noteto
python -m http.server
```
Then open in your browser.
If you plan to contribute a Pull Request, please install and run `eslint` to ensure correct code formatting:
```
npm install
eslint ./noteto/
```
## Tools for transferring templates to tablet
- [Remarkable Assistent](https://github.com/richeymichael/remarkable-assistant)
- [reMarkable HyUtilities](https://github.com/moovida/remarkable-hyutilities)
- [remarkable-tweak](https://github.com/morngrar/remarkable-tweak)
- [rM2 Template Helper](https://www.freeremarkabletools.com/) (Windows)
- [reMarkable Connection Utility (RCU)](http://www.davisr.me/projects/rcu/) (paid)
- [einkpads - Template installer](https://www.einkpads.com/products/remarkable-template-installer-apple-computers) (paid)
- [Download templates created by the community](https://rm.ezb.io/)
- [Online Generator for templates with custom grids](https://templarian.github.io/remarkable/)
- [Getting Things Done templates](https://github.com/BartKeulen/remarkable-gtd-templates)
- [Business related templates](https://github.com/deo-so/reMarkable-Tablet-Templates---Free)
## Further links
- [RemarkableWiki - Templates](https://remarkablewiki.com/tips/templates) (customizing, further templates)