Commit 7329da9a authored by greg@1m's avatar greg@1m
Browse files

fix url readme

parent 424c596e
An open-source, cross-platform markdown editor designed for extensibility & flexibility
# Tiro Notes
![Tiro S2](https://user-images.githubusercontent.com/2981891/161093353-e9c2df15-ffca-4d2f-839d-ced9ced659b1.jpg)
An open-source, cross-platform markdown editor designed for extensibility & flexibility
Twitter News & Updates : https://twitter.com/NotesTiro
🌐 website| 📘 documentation| ⬇️ downloads| 💬 forum | 📢 news|
-|-|-|-|-
[tiro-notes.org](https://dotgreg.github.io/tiro-notes)|[guides](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags)|[download page](https://dotgreg.github.io/tiro-notes/#/downloads)|[forum](https://github.com/dotgreg/tiro-notes/discussions)|[twitter](https://twitter.com/NotesTiro)|
## WHY
Tiro Notes is designed to be a viable open source alternative to proprietary software like Evernote, OneNote etc.
![Tiro 0.30](https://user-images.githubusercontent.com/2981891/171833721-2acdc59d-8c21-4280-bd62-a78023731c22.png)
Tiro Notes focus points are :
- 🏋 **Extensibilitility** : Integrate functionnalities inside your markdown notes using custom tags like [[latex]], [[uml]] or [[charts]], easily add [[pdf]] or youtube [[video]] to your notes. Add [[spreadsheet]] logic to your markdown tables, extend Tiro capacities by using a [[rss]] reader or a [[calendar]].
- 🏋 **Extensibility** : Tiro Notes uses a system of custom tags to extend its capabilities :
- Add [```[[latex]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=latex), [```[[uml]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=mermaid) or [```[[charts]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=mermaid), preview your pdf, mp4 or youtube links using [```[[view]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=view). Add [```[[spreadsheet]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=spreadsheet) logic to your markdown tables.
- Use Tiro as an app platform with a [```[[rss]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=rss) reader or a [```[[calendar]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=calendar) in it.
- [Create your own custom tags](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags) and use the [Client API](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags?id=using-tiro-client-api).
- 🏋 **Flexibility** : multi-window interface to create a custom workspace. Create multiple workspaces organized by tabs. Keep these workspaces synced accross your devices.
- 🎛️ **Flexibility** : multi-window interface to create a custom workspace. Create multiple workspaces organized by tabs. Keep these workspaces synced accross your devices.
- 👑 **Open source & Open Data**: Code is open source and free. No database required. Markdown files only. You can edit and sync your files with external software as you need.
- ☁️ / 🖥️ / 💻 / 📱 **Cross-platform & Web** : Windows, macOS, Android, Linux, Web. Start an App or with CLI and access it anywhere on your local network.
## USAGE
### DESKTOP APPLICATIONS
Mac/Linux/Windows Applications can be downloaded [here](https://github.com/dotgreg/tiro-notes/releases/tag/production)
### COMMAND LINE
- Requirements : [NodeJs](https://nodejs.org/en/download/) and [RipGrep](https://github.com/BurntSushi/ripgrep)
```
npx tiro-notes
```
<img src="https://user-images.githubusercontent.com/2981891/159723396-b5e81dcd-a4aa-4581-9b7f-e3b62bcdef65.gif" width="600"/>
- This works with any platform/device, including unrooted Android with [Termux](https://termux.com) and possibly iOS with iSH (untested)
- ```npx tiro-notes --help``` for all available options
## FUNCTIONALITIES LIST
# Functionalities
**Note Edition**
- 🖊️ Mardown notes edition
......@@ -46,13 +33,14 @@ npx tiro-notes
- 🔑 End to end (E2E) note encryption (RSA 2048)
- 🏛 Note changes history
- 📄 Export to PDF
- 💱 display math formulas with [[latex]]
- (🔧) 💬 Text to Speech (beta)
**Custom Tags**
- 💱 display math formulas with [[latex]]
- 🧬 display UML and other diagrams with [[diagram]]
- 🏋 Embed videos, pdf and web content with [[view]]
- 🏋 create javascript applications within your note with [[script]]
- 🏋 Embed videos and other web content (with iframe)
- 🧬 leverage the full [Client API](guide-custom-tags?id=using-tiro-client-api) in [[script]]
**Search**
- 🔍 Fast search (~2s for 30k notes)
......@@ -78,277 +66,4 @@ npx tiro-notes
- 📟 Use it on any device with a browser (Mobile, tablet and Desktop interface)
- (🔧)📱 Install on iOS with iSH and NPX (to be tested...)
### Client API (Beta)
<details>
<summary>Expand for details</summary>
Tiro Notes provides a Client API accessible using the developer console of your browser :
![Screenshot 2022-03-31 at 18 39 22](https://user-images.githubusercontent.com/2981891/161106559-b27890d1-fca4-4e66-a6ff-0bdf38f679b3.jpg)
typing ``` window.tiroCli ``` will give you the updated list of available functions. Each function has a description ```window.tiroCli.FUNCTION.description``` and can be called like that ```window.tiroCli.FUNCTION.f()```
The Tiro Cli allows you to :
- fetch a note content : ```window.tiroCli.clientApiGetFileContent```
- modify a note content : ```window.tiroCli.clientApiSetFileContent```
- Load an external javascript file : ```window.tiroCli.loadScripts(['https://', 'https://', ...], function () => {})```
- Show the current note content : ```window.tiroCli.fileContent```
- Trigger a search in the interface : ```window.tiroCli.triggerSearch```
- Set the Dual Editor view type temporarily : ```window.tiroCli.setTempViewType ("both", "editor", "preview")```
/!\ this API and CLI structure is meant to change in term of structure, make sure to check window.tiroCli when upgrading to a new version /!\
</details>
## FAQ
### How can I sync my notes folder on other devices?
You can use any sync solution like dropbox, google drive, resilio sync, syncthings etc...
### Can I edit my notes on another application?
Yes, all the datas Tiro uses is coming from markdown notes. So you can edit your notes in other applications without any problem.
### Where are located the configuration file and the logs of Tiro?
The configuration file is located at ```~/.tiro-config.json``` for linux, mac and termux android and under ```/Users/USER_NAME/.tiro-config.json```in windows.
The logs are also located at the same path ```.tiro-logs.txt``` if using NPX or Node directly and ```.tiro-electron-log.txt``` if using Tiro Notes Desktop Apps.
### How can I use Tiro in the Web?
1) Device where tiro is installed : http://localhost:3023
2) If on same Wifi/local network: http://192.168.xx.xx:3023 where that ip is the ip of the device where tiro is installed
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.
4) On the cloud: You can self-host/install Tiro Notes on your server and access it from anywhere.
### What is the current status of Tiro Notes?
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.
I haven't been loosing any data so far, and there is always the history note functionality in that case.
However, I consider that application still in alpha phase, it still needs a lot of testing to be considered robust.
So use it at your own risk, and always with data you can afford to lose.
### How can I contribute?
Contributions and PR are welcome! You can contact me for more details on the ROADMAP and how to be involved.
Right now, Tiro Notes needs testers to stabilize the current scope of functionalities and to give feedbacks on it.
Also translation can be a nice thing to have in the future.
Twitter News & Updates : https://twitter.com/NotesTiro
============ STRUCTURE
## DOCUMENTATION
### Available Custom Tags
- [[calendar]] a fully functional calendar that stored data on a note : [install instructions & screenshot](https://github.com/dotgreg/tiro-notes/blob/master/documentation/custom-tag-calendar.md)
- [[mermaid]] Uml, Gantt and flowcharts : [install instructions & screenshot](https://github.com/dotgreg/tiro-notes/blob/master/documentation/custom-tag-mermaid.md)
### Add scripts in your note
<details>
<summary>Expand for details</summary>
You can add javascript logic in your note with the special tag [[script]]
You need to use ```return``` to output it in the preview.
```
.... Note content ....
[[script]]]
const stringToDisplay = `this is a hello world from javascript`
const randomNumber = Math.round(Math.random() * 1000)
return `${stringToDisplay} ${randomNumber} `
[[script]]
.... Note content ....
```
will output something like
```
.... Note content ....
this is a hello world from javascript 102
.... Note content ....
```
</details>
### Create your own custom tags
<details>
<summary>Expand for details</summary>
#### 1) How to create a new custom tag [[mail-address]]
In order to install a new tag, you need to create a new note in ```/.tiro/tags/``` folder. (create the /tags directory if doesn't exists).
The content of that note will then be placed instead of the tag.
So in order to create a custom tag [[mail-address]], you will need to create ```/.tiro/tags/mail-address.md```
So with ```/.tiro/tags/mail-address.md``` content being :
```
10 Downing Street
City of Westminster
London, SW1
```
And your note content being
```
.... Note content ....
[[mail-address]] [[mail-address]]
.... Note content ....
```
The result will give
```
.... Note content ....
10 Downing Street
City of Westminster
London, SW1
.... Note content ....
```
#### 2) Using {{InnerTag}}
The content inside the custom tags can be fetched with the special tag ```{{innerTag}}```
So with ```/.tiro/tags/mail-address.md``` content being :
```
10 Downing Street
City of Westminster
London, SW1
{{innerTag}}
```
Calling ```[[mail-address]] John Foo [[mail-address]]``` in any note will be replaced by
```
10 Downing Street
City of Westminster
London, SW1
John Foo
```
### 3) Add script logic in your tag
You can add javascript to your custom tag with the special tag [[script]]
If we have ```/.tiro/tags/square-number.md``` with the following content :
```
The multiplied result is :
[[script]]]
const numberToSquare = {{innerTag}}
return `${numberToSquare * numberToSquare}`
[[script]]
```
Using ```[[square-number]] 4 [[square-number]]``` will return ```The multiplied result is : 16```
</details>
### Publish my own custom tags to tiro website
You can do a Push Request (PR) in https://github.com/dotgreg/tiro-notes and add your own folder-name inside /custom-tags/MY_CUSTOM_TAG_NAME. Or you can email me if that last sentence sounded confusing to you :).
=================
- Available Custom Tags
# How to:
## Install a Custom Tag
A custom tag is a markdown note called in another markdown note.
So you can create your own custom tag within seconds and without any coding knowledge [[LINK]], like a [[header-link]] to display a note header with some links on your notes.
The principle is simple : To create a new custom tag [[header-link]] , create a markdown note named ```header-link``` in the ```/.tiro/.tags/```. It will then be available across your notes.
To install any of these listed custom tags, create a new note and paste the content in it.
*For those with javascript knowledge, it is also really easy to create your own mini-apps and widgets with it leveraging the tiro client API to get/save content, use popups, tabs and windows, manipulate the interface etc. The mermaid custom tag required for instance less than 10 lines of code.
## How to update a custom tag
It will auto-update itself if it finds a new version available.
If you prefer to stay at a specific version, you can replace the url ```https://tiro-notes.org/ctags/latest/rss```by the ```https://tiro-notes.org/ctags/1.0.0/rss```
If you prefer not depending on a server/external resources, you can simply take the note content requested, in our case https://tiro-notes.org/custom-tags/latest/rss, and paste it in the note directly.
## How to install third-party Custom tags
Simply paste the provided code in the note. However make sure to trust the developer of that code as a custom tags can access to your notes content!
## How to publish my own custom tags to tiro website
You can do a Push Request (PR) in https://github.com/dotgreg/tiro-notes and add your own folder-name inside /custom-tags/MY_CUSTOM_TAG_NAME. Or you can email me if that last sentence sounded confusing to you :).
# List
## [[latex]]
## [[mermaid]] (UML/Gantt/Flowcharts/Pies)
## [[chart]]
## [[spreadsheet]]
## [[youtube]]
## [[rss]]
### Description:
A full fledge RSS reader inside Tiro Notes. Designed to work on small screens/windows as well as on desktop.
Simply call it and paste your rss feeds with their name in it
### Example :
```
[[rss]]
fig_vox https://www.lefigaro.fr/rss/figaro_vox.xml
courInt https://www.courrierinternational.com/feed/all/rss.xml
eur1_grd https://www.europe1.fr/rss/podcasts/le-grand-rendez-vous.xml
lemonde https://www.lemonde.fr/rss/une.xml
korben https://korben.info/feed
mondiplo https://www.monde-diplomatique.fr/recents.xml
[[rss]]
```
### Changelog :
- v0.30.3 : 02/06/2022 : fixing issues
### Screenshot :
### Install/Code :
```
```
============================
- Getting Started
- Presentation
- Downloads => redirect to dl page? ou dl directement? => dl directement ouaiii
- Available Custom Tags
============================
A custom tag is a markdown note called in another markdown note.
So you can create your own custom tag within seconds and without any coding knowledge [[LINK]], like a [[header-link]] to display a note header with some links on your notes.
The principle is simple : To create a new custom tag [[header-link]] , create a markdown note named ```header-link``` in the ```/.tiro/.tags/```. It will then be available across your notes.
To install any of these listed custom tags, create a new note and paste the content in it.
*For those with javascript knowledge, it is also really easy to create your own mini-apps and widgets with it leveraging the tiro client API to get/save content, use popups, tabs and windows, manipulate the interface etc. The mermaid custom tag required for instance less than 10 lines of code.
If you want to create a custom tag named [[header-link]], create a markdown note named ```header-link``` in the ```/.tiro/.tags/```. It will then be available across your notes.
\ No newline at end of file
>"Marcus Tullius Tiro, a learned freedman who was a member of Cicero’s household, invented the Tironian notes, the first Latin shorthand system. Tironian notes consist of letters of the alphabet, simplified and modified to achieve greater speed in their writing."
\ No newline at end of file
......@@ -2,9 +2,9 @@
An open-source, cross-platform markdown editor designed for extensibility & flexibility
🌐 website| 📘 documentation| ⬇️ downloads| 💬 forum | 📢 news|
-|-|-|-|-
[tiro-notes.org](https://dotgreg.github.io/tiro-notes)|[guides](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags)|[download page](https://dotgreg.github.io/tiro-notes/#/downloads)|[forum](https://github.com/dotgreg/tiro-notes/discussions)|[twitter](https://twitter.com/NotesTiro)|
🌐 website| 📘 guides| ⬇️ downloads| 💬 forum | 📢 news| Version |
-|-|-|-|-|-
[tiro-notes.org](https://tiro-notes.org)|[guides](https://tiro-notes.org/#/guide-custom-tags)|[download](https://tiro-notes.org/#/downloads)|[forum](https://github.com/dotgreg/tiro-notes/discussions)|[twitter](https://twitter.com/NotesTiro)| 0.30 (beta)
![Tiro 0.30](https://user-images.githubusercontent.com/2981891/171833721-2acdc59d-8c21-4280-bd62-a78023731c22.png)
......@@ -12,9 +12,9 @@ An open-source, cross-platform markdown editor designed for extensibility & flex
Tiro Notes focus points are :
- 🏋 **Extensibility** : Tiro Notes uses a system of custom tags to extend its capabilities :
- Add [```[[latex]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=latex), [```[[uml]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=mermaid) or [```[[charts]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=mermaid), preview your pdf, mp4 or youtube links using [```[[view]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=view). Add [```[[spreadsheet]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=spreadsheet) logic to your markdown tables.
- Use Tiro as an app platform with a [```[[rss]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=rss) reader or a [```[[calendar]]```](https://dotgreg.github.io/tiro-notes/#/custom-tags?id=calendar) in it.
- [Create your own custom tags](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags) and use the [Client API](https://dotgreg.github.io/tiro-notes/#/guide-custom-tags?id=using-tiro-client-api).
- Add [```[[latex]]```](https://tiro-notes.org/#/custom-tags?id=latex), [```[[uml]]```](https://tiro-notes.org/#/custom-tags?id=mermaid) or [```[[charts]]```](https://tiro-notes.org/#/custom-tags?id=mermaid), preview your pdf, mp4 or youtube links using [```[[view]]```](https://tiro-notes.org/#/custom-tags?id=view). Add [```[[spreadsheet]]```](https://tiro-notes.org/#/custom-tags?id=spreadsheet) logic to your markdown tables.
- Use Tiro as an app platform with a [```[[rss]]```](https://tiro-notes.org/#/custom-tags?id=rss) reader or a [```[[calendar]]```](https://tiro-notes.org/#/custom-tags?id=calendar) in it.
- [Create your own custom tags](https://tiro-notes.org/#/guide-custom-tags) and use the [Client API](https://tiro-notes.org/#/guide-custom-tags?id=using-tiro-client-api).
- 🎛️ **Flexibility** : multi-window interface to create a custom workspace. Create multiple workspaces organized by tabs. Keep these workspaces synced accross your devices.
......@@ -33,14 +33,14 @@ Tiro Notes focus points are :
- 🔑 End to end (E2E) note encryption (RSA 2048)
- 🏛 Note changes history
- 📄 Export to PDF
- 💱 display math formulas with [[latex]]
- (🔧) 💬 Text to Speech (beta)
**Custom Tags**
- 💱 display math formulas with [[latex]]
- 🧬 display UML and other diagrams with [[diagram]]
- 🏋 Embed videos, pdf and web content with [[view]]
- 🏋 create javascript applications within your note with [[script]]
- 🧬 leverage the full [Client API](guide-custom-tags?id=using-tiro-client-api) in [[script]]
- 🏋 Embed videos and other web content (with iframe)
**Search**
- 🔍 Fast search (~2s for 30k notes)
......
......@@ -48,7 +48,9 @@
"export-server": "run-s export-server-1 export-server-2",
"export-server-1": "cp -r server/build ./build/server",
"export-server-2": "cp -r server/ssl ./build/server/ssl",
"export-readme": "cp README.md ./build/",
"export-readme": "run-s export-readme-1 export-readme-2",
"export-readme-1": "cp docs/README.md README.md",
"export-readme-2": "cp README.md ./build/",
"================== MISC =================== ": "",
"__TEST__": "",
"test1": "(node -e \"console.log('log1');\") && echo wooop",
......
{
"name": "tiro-notes",
"version": "0.30.39-dev",
"version": "0.30.40-dev",
"description": "Tiro Notes CLI to start Tiro Notes from the command line!",
"scripts": {
"dev": "ISDEV=true node cli.js",
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment