tiro-notes 0.27.37 → 0.27.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -69
- package/package.json +1 -1
- package/server/server.js +1 -1
package/README.md
CHANGED
|
@@ -1,89 +1,79 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Tiro Notes
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Open-source, fast and supercharged markdown editor to be used anywhere
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
## Why
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Tiro Notes is designed to be a viable open source alternative to proprietary software like Evernote, OneNote etc.
|
|
10
10
|
|
|
11
|
-
|
|
11
|
+
Tiro Notes focus points are :
|
|
12
12
|
|
|
13
|
-
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
-
|
|
13
|
+
- 👼 **Open source & free**: Code is open source, free forever. Optimistically reaching a GNU GPLv3 license in the future.
|
|
14
|
+
- 👑 **Own your data**: No database, no hidden ties. Markdown files only. You can edit and sync your files with external software as you need.
|
|
15
|
+
- 🚅 **Fast**: Search is really fast (using ripgrep). You can scroll list of several thousands of items without slowdown.
|
|
16
|
+
- 💅 **Nice**: Usability & nice user experience is key aspect of Tiro.
|
|
17
|
+
- 📟 **Use it anywhere** : Apps for Windows, Mac, Linux. You can install and start Tiro within seconds with npx. You can install it on Android and iOS. You can use it as web server and use it with any device with a browser.
|
|
18
|
+
- 🏋 **Extensibility** : custom and extensible markdown tags like [[latex]] or [[script]] or with third party plugins (planned).
|
|
18
19
|
|
|
19
|
-
##
|
|
20
|
+
## Functionalities & Status
|
|
20
21
|
|
|
21
|
-
|
|
22
|
-
-
|
|
23
|
-
-
|
|
22
|
+
**Note Edition**
|
|
23
|
+
- 🖊️ Mardown notes edition
|
|
24
|
+
- 🌄 Drag and Drop images & files upload (stored in a relative .resources folder)
|
|
25
|
+
- 🔗 Notes linking
|
|
26
|
+
- 🔑 End to end (E2E) note encryption (RSA 2048)
|
|
27
|
+
- 🏛 Note changes history
|
|
28
|
+
- 📄 Export to PDF
|
|
29
|
+
- 🏋 Embed videos and other web content (with iframe)
|
|
30
|
+
- 🏋 create javascript applications within your note with [[script]]
|
|
31
|
+
- 💱 display math formulas with [[latex]]
|
|
32
|
+
- (🔧) 💬 Text to Speech (beta)
|
|
33
|
+
- (🔧) 🧬 display UML and other diagrams with [[diagram]] (planned...)
|
|
34
|
+
- (🔧) 📡 Server Collaborative edition (planned...)
|
|
24
35
|
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
36
|
+
**Search**
|
|
37
|
+
- 🔍 Fast search (~2s for 30k notes)
|
|
38
|
+
- 🔬 Search filters (intitle: etc...)
|
|
28
39
|
|
|
29
|
-
|
|
40
|
+
**Folders Tree & Notes List**
|
|
41
|
+
- 🗂️ Folders management (create/rename/move/delete)
|
|
42
|
+
- 🏎️ Fast Notes List (can display 10k files without slowdown)
|
|
43
|
+
- 🧮 Notes List sorting (date creation/date modification/name)
|
|
44
|
+
- 👁️ Note preview in Notes List (with image and text)
|
|
45
|
+
- 📤 Last notes edited
|
|
46
|
+
- 🌄 Images list view
|
|
30
47
|
|
|
31
|
-
|
|
48
|
+
**Security**
|
|
49
|
+
- 🔒 Application login (user/password)
|
|
50
|
+
- 🔒 HTTPS support (with self signed certificate)
|
|
32
51
|
|
|
33
|
-
|
|
52
|
+
**Platforms
|
|
53
|
+
- 💻 Windows/Mac/Linux applications
|
|
54
|
+
- 🥷 10 seconds install & start with command line NPX
|
|
55
|
+
- 📱 Install on Android with Termux and NPX
|
|
56
|
+
- ☁️ Use it as a local application, as a local or cloud server.
|
|
57
|
+
- 📟 Use it on any device with a browser (Mobile, tablet and Desktop interface)
|
|
58
|
+
- (🔧)📱 Install on iOS with iSH and NPX (to be tested...)
|
|
34
59
|
|
|
60
|
+
## USAGE
|
|
35
61
|
|
|
36
|
-
## CURRENT STATUS
|
|
37
|
-
I have been developing it for over a year and using it as my daily note app for over 6 months now, its core functionalities seems stable enough for my use so far.
|
|
38
|
-
I haven't been loosing any data so far, and there is always the history note functionality in that case.
|
|
39
62
|
|
|
40
|
-
|
|
63
|
+
### 1) COMMAND LINE
|
|
64
|
+
- Requirements : [NodeJs](https://nodejs.org/en/download/) and [RipGrep](https://github.com/BurntSushi/ripgrep)
|
|
41
65
|
|
|
42
|
-
|
|
66
|
+
```
|
|
67
|
+
npx tiro-notes
|
|
68
|
+
```
|
|
43
69
|
|
|
44
|
-
|
|
70
|
+
<img src="https://user-images.githubusercontent.com/2981891/159723396-b5e81dcd-a4aa-4581-9b7f-e3b62bcdef65.gif" width="600"/>
|
|
45
71
|
|
|
46
|
-
|
|
72
|
+
This works with any platform/device, including unrooted Android with [Termux](https://termux.com) and possibly iOS with iSH (untested)
|
|
47
73
|
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
| TYPE | FUNCTION | STATUS |
|
|
52
|
-
|---------------------+-----------------------------------+---------|
|
|
53
|
-
| Note Edition | markdown dual editor | OK |
|
|
54
|
-
| | note id, note tags, note link | OK |
|
|
55
|
-
| | attach image/document | OK |
|
|
56
|
-
| | drag and drop | OK |
|
|
57
|
-
| | note encryption | OK |
|
|
58
|
-
| | note images as slideshow | OK |
|
|
59
|
-
| | [[latex]] support | OK |
|
|
60
|
-
| | [[script]] support | OK |
|
|
61
|
-
| | note history | OK |
|
|
62
|
-
| | note download (pdf via print) | Beta |
|
|
63
|
-
| | text to speech | Beta |
|
|
64
|
-
| | collaborative edition | Planned |
|
|
65
|
-
|---------------------+-----------------------------------+---------|
|
|
66
|
-
| Notes list | Notes Infinite scroll list | OK |
|
|
67
|
-
| | Image gallery view | OK |
|
|
68
|
-
| | Sort List | OK |
|
|
69
|
-
| | Last Notes edited (per device) | OK |
|
|
70
|
-
| | Notes Management (CRUD) | OK |
|
|
71
|
-
| | Folder management (CRUD) | OK |
|
|
72
|
-
|---------------------+-----------------------------------+---------|
|
|
73
|
-
| Note Search | Searching note from content | OK |
|
|
74
|
-
| | Searching note from title | OK |
|
|
75
|
-
|---------------------+-----------------------------------+---------|
|
|
76
|
-
| Desktop Application | Nodejs application | OK |
|
|
77
|
-
| | Windows/Mac/linux | ... |
|
|
78
|
-
| | Cli via NPX | ... |
|
|
79
|
-
|---------------------+-----------------------------------+---------|
|
|
80
|
-
| Mobile Applications | Android (via termux) | OK |
|
|
81
|
-
| | Mobile/tablet interface | OK |
|
|
82
|
-
|---------------------+-----------------------------------+---------|
|
|
83
|
-
| Other | Application login (user/password) | OK |
|
|
84
|
-
| | | |
|
|
85
|
-
|---------------------+-----------------------------------+---------|
|
|
86
|
-
```
|
|
74
|
+
|
|
75
|
+
### 2) APPS (Coming...)
|
|
76
|
+
Mac/Linux/Windows Electron Apps coming soon...
|
|
87
77
|
|
|
88
78
|
# FAQ
|
|
89
79
|
|
|
@@ -91,10 +81,19 @@ I am not responsible of any data loss!
|
|
|
91
81
|
You can use any sync solution like dropbox, google drive, resilio sync, syncthings etc...
|
|
92
82
|
|
|
93
83
|
## Can I edit my notes on another application?
|
|
94
|
-
Yes, all the datas Tiro uses is coming from markdown notes
|
|
84
|
+
Yes, all the datas Tiro uses is coming from markdown notes. So you can edit your notes in other applications without any problem.
|
|
95
85
|
|
|
96
86
|
## How can I access to Tiro on my device
|
|
97
87
|
1) Device where tiro is installed : http://localhost:3023
|
|
98
88
|
2) If on same local network: http://192.168.xx.xx:3023 where that ip is the ip of the device where tiro is installed
|
|
99
|
-
3) Not on same network : Tiro works great using SSH tunneling, AutoSSH or similar (free ssh tunnels solutions exists like https://opentunnel.net/)
|
|
89
|
+
3) Not on same network : Tiro works great using SSH tunneling, AutoSSH or similar (free ssh tunnels solutions exists like https://opentunnel.net/). Npx tiro-notes also includes a --tunnel option for easy tunneling.
|
|
90
|
+
|
|
91
|
+
## What is the current status of Tiro Notes?
|
|
92
|
+
I have been developing it for over a year and using it as my daily note app for over 6 months now, its core functionalities seems stable enough for my use so far.
|
|
93
|
+
I haven't been loosing any data so far, and there is always the history note functionality in that case.
|
|
100
94
|
|
|
95
|
+
However, I consider that application still in alpha phase, it still needs a lot of testing to be considered robust.
|
|
96
|
+
|
|
97
|
+
So use it at your own risk, and always with data you can afford to lose.
|
|
98
|
+
|
|
99
|
+
I am not responsible of any data loss!
|