Skip to content

Commit

Permalink
add logos of the supported apps and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marph91 committed Oct 9, 2024
1 parent 9e2e2ea commit 1a81373
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/contributing/more_note_apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Loose collection of note apps/messengers/wikis/formats that could be implemented
| App/Format | Backup/Export | Remarks |
| --- | --- | --- |
| [Affine](https://github.com/toeverything/AFFiNE) | [doc](https://docs.affine.pro/docs/settings) | |
| [Agenda](https://agenda.com/) | | apple only |
| [Agenda](https://agenda.com/) | [doc](https://agenda.community/t/sharing-import-export-and-printing/56) | apple only |
| [Anytype](https://anytype.io/) | | |
| [Apple Notes](https://www.icloud.com/notes) | [script](https://github.com/mattrose/AppleNotes2Joplin) | apple only |
| [Appflowy](https://appflowy.io/) | [seems to be not possible yet](https://github.com/AppFlowy-IO/AppFlowy/issues/4387) | |
Expand Down
6 changes: 3 additions & 3 deletions docs/formats/default.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ The default import covers the following formats:
- Every format that is supported by [pandoc](https://pandoc.org/). Some formats may need some tweaking, though. A few examples:
- CSV
- DocBook
- docx
- DOCX
- EPUB
- HTML
- Jupyter notebook
- Jupyter Notebook
- MediaWiki
- ODT
- OPML
- MediaWiki
- reStructuredText
- RTF
- txt2tags
Expand Down
2 changes: 1 addition & 1 deletion docs/formats/vcard.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This page describes how to convert notes from vCard to Markdown.

1. Export your contacts in vCard format
2. [Install jimmy](../index.md#installation)
3. Convert to Markdown. Example: `jimmy-cli-linux vcards_20240811_175319.vcf--format vcard`
3. Convert to Markdown. Example: `jimmy-cli-linux vcards_20240811_175319.vcf --format vcard`
4. [Import to your app](../import_instructions.md)

## Import Structure
Expand Down
22 changes: 16 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Features

-Many input formats, like Google Keep, Standard Notes, Synology Note Station, Zoho Notebook and more
-Several supported input formats
- ✅ Markdown + Frontmatter output
- Compatible with any text editor
- Can be imported to Joplin/Obsidian/...
Expand All @@ -18,14 +18,24 @@

**Download jimmy here: [Linux](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-linux) | [Windows](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-windows.exe) | [MacOS](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-darwin)**

!!! note
## Supported Apps

The MacOS app is untested.
||||||
| :---: | :---: | :---: | :---: | :---: |
| <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3d/Anki-icon.svg/240px-Anki-icon.svg.png" style="height:100px;max-width:100px;"><br>[Anki](https://marph91.github.io/jimmy/formats/anki/) | <img src="https://bear.app/images/logo.png" style="height:100px;max-width:100px;"><br>[Bear](https://marph91.github.io/jimmy/formats/bear/) | <img src="https://raw.githubusercontent.com/CacherApp/cacher-cli/e241f06867dba740131db5314ef7fe279135baf6/images/cacher-icon.png" style="height:100px;max-width:100px;"><br>[Cacher](https://marph91.github.io/jimmy/formats/cacher/) | <img src="https://raw.githubusercontent.com/giuspen/cherrytree/c822b16681b002b8882645d8d1e8f109514ddb58/icons/cherrytree.svg" style="height:100px;max-width:100px;"><br>[CherryTree](https://marph91.github.io/jimmy/formats/cherrytree/) | <img src="https://avatars.githubusercontent.com/u/53916365?s=200&v=4" style="height:100px;max-width:100px;"><br>[Clipto](https://marph91.github.io/jimmy/formats/clipto/) |
| <img src="https://seeklogo.com/images/D/day-one-logo-F4CA245C26-seeklogo.com.png" style="height:100px;max-width:100px;"><br>[Day&nbsp;One](https://marph91.github.io/jimmy/formats/day_one/) | <img src="https://images.saasworthy.com/dynalist_5288_logo_1576239391_xhkcg.jpg" style="height:100px;max-width:100px;"><br>[Dynalist](https://marph91.github.io/jimmy/formats/dynalist/) | <img src="https://upload.wikimedia.org/wikipedia/commons/b/b8/2021_Facebook_icon.svg" style="height:100px;max-width:100px;"><br>[Facebook](https://marph91.github.io/jimmy/formats/facebook/) | <img src="https://wavebox.pro/store2/store/0b46bf0a-107c-4fa2-a657-3df7412e3d3d.png" style="height:100px;max-width:100px;"><br>[FuseBase, Nimbus&nbsp;Note](https://marph91.github.io/jimmy/formats/fusebase/) | <img src="https://www.gstatic.com/images/branding/product/1x/docs_2020q4_96dp.png" style="height:100px;max-width:100px;"><br>[Google&nbsp;Docs](https://marph91.github.io/jimmy/formats/google_docs/) |
| <img src="https://www.gstatic.com/images/branding/product/1x/keep_2020q4_96dp.png" style="height:100px;max-width:100px;"><br>[Google&nbsp;Keep](https://marph91.github.io/jimmy/formats/google_keep/) | <img src="https://github.com/laurent22/joplin/blob/dev/Assets/LinuxIcons/128x128.png?raw=true" style="height:100px;max-width:100px;"><br>[Joplin](https://marph91.github.io/jimmy/formats/joplin/) | <img src="https://raw.githubusercontent.com/jrnl-org/jrnl/85a98afcd91ed873c0eceba9893c3ec424f201b8/docs_theme/img/logo.svg" style="height:100px;max-width:100px;"><br>[jrnl](https://marph91.github.io/jimmy/formats/jrnl/) | <img src="https://upload.wikimedia.org/wikipedia/commons/4/45/Notion_app_logo.png" style="height:100px;max-width:100px;"><br>[Notion](https://marph91.github.io/jimmy/formats/notion/) | <img src="https://upload.wikimedia.org/wikipedia/commons/1/10/2023_Obsidian_logo.svg" style="height:100px;max-width:100px;"><br>[Obsidian](https://marph91.github.io/jimmy/formats/obsidian/) |
| <img src="https://raw.githubusercontent.com/pbek/QOwnNotes/d89a597a28eeb16f57692ac121933b478f44bf07/src/images/icons/256x256/apps/QOwnNotes.png" style="height:100px;max-width:100px;"><br>[QOwnNotes](https://marph91.github.io/jimmy/formats/qownnotes/) | <img src="https://raw.githubusercontent.com/jendrikseipp/rednotebook/b2cefe5f321b21ab7ad855059f3c0496eb0830d2/rednotebook/images/rednotebook-icon/rn-256.png" style="height:100px;max-width:100px;"><br>[RedNotebook](https://marph91.github.io/jimmy/formats/rednotebook/) | <img src="https://raw.githubusercontent.com/Automattic/simplenote-electron/4a140a96545763c849b26a81a2e27ff67eaa68f0/lib/icons/app-icon/icon_256x256.png" style="height:100px;max-width:100px;"><br>[Simplenote](https://marph91.github.io/jimmy/formats/simplenote/) | <img src="https://avatars.githubusercontent.com/u/24537496?s=100" style="height:100px;max-width:100px;"><br>[Standard&nbsp;Notes](https://marph91.github.io/jimmy/formats/standard_notes/) | <img src="https://www.synology.com/img/dsm/note_station/notestation_72.png" style="height:100px;max-width:100px;"><br>[Synology Note&nbsp;Station](https://marph91.github.io/jimmy/formats/synology_note_station/) |
| [Textbundle, Textpack](https://marph91.github.io/jimmy/formats/textbundle/) | <img src="https://talk.tiddlywiki.org/uploads/default/original/1X/5d4e8afa05b64280281f851dfc982796b5f7fcd1.svg" style="height:100px;max-width:100px;"><br>[Tiddlywiki](https://marph91.github.io/jimmy/formats/tiddlywiki/) | <img src="https://dl.flathub.org/media/org/gnome/Gnote/4f2ede31f33a5f935bec4206a6035410/icons/128x128/org.gnome.Gnote.png" style="height:100px;max-width:100px;"><br>[Tomboy-ng, Gnote](https://marph91.github.io/jimmy/formats/tomboy_ng/) | [vCard](https://marph91.github.io/jimmy/formats/vcard/) | <img src="https://raw.githubusercontent.com/Zettelkasten-Team/Zettelkasten/refs/heads/main/src/main/resources/de/danielluedecke/zettelkasten/resources/icons/zkn3-256x256.png" style="height:100px;max-width:100px;"><br>[Zettelkasten](https://marph91.github.io/jimmy/formats/zettelkasten/) |
| <img src="https://zim-wiki.org/images/globe.png" style="height:100px;max-width:100px;"><br>[Zim](https://marph91.github.io/jimmy/formats/zim/) | <img src="https://zohowebstatic.com/sites/default/files/ogimage/notebook-logo.png" style="height:100px;max-width:100px;"><br>[Zoho&nbsp;Notebook](https://marph91.github.io/jimmy/formats/zoho_notebook/) ||||

Alternative installation options:
## Supported Formats

1. CLI app: `jimmy-cli-*`. Available at the [release page](https://github.com/marph91/jimmy/releases/latest).
2. Clone the repository and use it from python by `python src/jimmy_cli.py`.
||||||
| :---: | :---: | :---: | :---: | :---: |
| <img src="https://avatars.githubusercontent.com/u/3137042?s=100&v=4" style="height:100px;max-width:100px;"><br>[Asciidoc](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/3/34/Microsoft_Office_Excel_%282019%E2%80%93present%29.svg" style="height:100px;max-width:100px;"><br>[CSV](https://marph91.github.io/jimmy/formats/default/) | [DocBook](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/f/fd/Microsoft_Office_Word_%282019%E2%80%93present%29.svg" style="height:100px;max-width:100px;"><br>[docx](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/9/91/Epub_logo.svg" style="height:100px;max-width:100px;"><br>[EPUB](https://marph91.github.io/jimmy/formats/default/) |
| <img src="https://fountain.io/wp-content/uploads/2023/05/fountain-sign-164-150x150.png" style="height:100px;max-width:100px;"><br>[Fountain](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/6/61/HTML5_logo_and_wordmark.svg" style="height:100px;max-width:100px;"><br>[HTML](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/3/38/Jupyter_logo.svg" style="height:100px;max-width:100px;"><br>[Jupyter Notebook](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/f/f4/Markdown-mark-4th.svg" style="height:100px;max-width:100px;"><br>[Markdown](https://marph91.github.io/jimmy/formats/default/) | <img src="https://www.mediawiki.org/static/images/icons/mediawikiwiki.svg" style="height:100px;max-width:100px;"><br>[MediaWiki](https://marph91.github.io/jimmy/formats/default/) |
| <img src="https://upload.wikimedia.org/wikipedia/commons/0/02/LibreOffice_6.1_Writer_Icon.svg" style="height:100px;max-width:100px;"><br>[ODT](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/2/2c/Opml-icon.svg" style="height:100px;max-width:100px;"><br>[OPML](https://marph91.github.io/jimmy/formats/default/) | [reStructuredText](https://marph91.github.io/jimmy/formats/default/) | [RTF](https://marph91.github.io/jimmy/formats/default/) | [txt2tags](https://marph91.github.io/jimmy/formats/default/) |

## General Usage

Expand Down
25 changes: 21 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ If this app is useful for you, feel free to star it on [github](https://github.c

## Features

-Many input formats, like Google Keep, Standard Notes, Synology Note Station, Zoho Notebook and more
-Several supported input formats
- ✅ Markdown + Frontmatter output
- Compatible with any text editor
- Can be imported to Joplin/Obsidian/...
Expand All @@ -22,6 +22,25 @@ If this app is useful for you, feel free to star it on [github](https://github.c
- ✅ Cross-platform
- ✅ Standalone (no Docker, Python or NodeJS installation required)

## Supported Apps

||||||
| :---: | :---: | :---: | :---: | :---: |
| <img src="https://upload.wikimedia.org/wikipedia/commons/thumb/3/3d/Anki-icon.svg/240px-Anki-icon.svg.png" style="height:100px;max-width:100px;"><br>[Anki](https://marph91.github.io/jimmy/formats/anki/) | <img src="https://bear.app/images/logo.png" style="height:100px;max-width:100px;"><br>[Bear](https://marph91.github.io/jimmy/formats/bear/) | <img src="https://raw.githubusercontent.com/CacherApp/cacher-cli/e241f06867dba740131db5314ef7fe279135baf6/images/cacher-icon.png" style="height:100px;max-width:100px;"><br>[Cacher](https://marph91.github.io/jimmy/formats/cacher/) | <img src="https://raw.githubusercontent.com/giuspen/cherrytree/c822b16681b002b8882645d8d1e8f109514ddb58/icons/cherrytree.svg" style="height:100px;max-width:100px;"><br>[CherryTree](https://marph91.github.io/jimmy/formats/cherrytree/) | <img src="https://avatars.githubusercontent.com/u/53916365?s=200&v=4" style="height:100px;max-width:100px;"><br>[Clipto](https://marph91.github.io/jimmy/formats/clipto/) |
| <img src="https://seeklogo.com/images/D/day-one-logo-F4CA245C26-seeklogo.com.png" style="height:100px;max-width:100px;"><br>[Day&nbsp;One](https://marph91.github.io/jimmy/formats/day_one/) | <img src="https://images.saasworthy.com/dynalist_5288_logo_1576239391_xhkcg.jpg" style="height:100px;max-width:100px;"><br>[Dynalist](https://marph91.github.io/jimmy/formats/dynalist/) | <img src="https://upload.wikimedia.org/wikipedia/commons/b/b8/2021_Facebook_icon.svg" style="height:100px;max-width:100px;"><br>[Facebook](https://marph91.github.io/jimmy/formats/facebook/) | <img src="https://wavebox.pro/store2/store/0b46bf0a-107c-4fa2-a657-3df7412e3d3d.png" style="height:100px;max-width:100px;"><br>[FuseBase, Nimbus&nbsp;Note](https://marph91.github.io/jimmy/formats/fusebase/) | <img src="https://www.gstatic.com/images/branding/product/1x/docs_2020q4_96dp.png" style="height:100px;max-width:100px;"><br>[Google&nbsp;Docs](https://marph91.github.io/jimmy/formats/google_docs/) |
| <img src="https://www.gstatic.com/images/branding/product/1x/keep_2020q4_96dp.png" style="height:100px;max-width:100px;"><br>[Google&nbsp;Keep](https://marph91.github.io/jimmy/formats/google_keep/) | <img src="https://github.com/laurent22/joplin/blob/dev/Assets/LinuxIcons/128x128.png?raw=true" style="height:100px;max-width:100px;"><br>[Joplin](https://marph91.github.io/jimmy/formats/joplin/) | <img src="https://raw.githubusercontent.com/jrnl-org/jrnl/85a98afcd91ed873c0eceba9893c3ec424f201b8/docs_theme/img/logo.svg" style="height:100px;max-width:100px;"><br>[jrnl](https://marph91.github.io/jimmy/formats/jrnl/) | <img src="https://upload.wikimedia.org/wikipedia/commons/4/45/Notion_app_logo.png" style="height:100px;max-width:100px;"><br>[Notion](https://marph91.github.io/jimmy/formats/notion/) | <img src="https://upload.wikimedia.org/wikipedia/commons/1/10/2023_Obsidian_logo.svg" style="height:100px;max-width:100px;"><br>[Obsidian](https://marph91.github.io/jimmy/formats/obsidian/) |
| <img src="https://raw.githubusercontent.com/pbek/QOwnNotes/d89a597a28eeb16f57692ac121933b478f44bf07/src/images/icons/256x256/apps/QOwnNotes.png" style="height:100px;max-width:100px;"><br>[QOwnNotes](https://marph91.github.io/jimmy/formats/qownnotes/) | <img src="https://raw.githubusercontent.com/jendrikseipp/rednotebook/b2cefe5f321b21ab7ad855059f3c0496eb0830d2/rednotebook/images/rednotebook-icon/rn-256.png" style="height:100px;max-width:100px;"><br>[RedNotebook](https://marph91.github.io/jimmy/formats/rednotebook/) | <img src="https://raw.githubusercontent.com/Automattic/simplenote-electron/4a140a96545763c849b26a81a2e27ff67eaa68f0/lib/icons/app-icon/icon_256x256.png" style="height:100px;max-width:100px;"><br>[Simplenote](https://marph91.github.io/jimmy/formats/simplenote/) | <img src="https://avatars.githubusercontent.com/u/24537496?s=100" style="height:100px;max-width:100px;"><br>[Standard&nbsp;Notes](https://marph91.github.io/jimmy/formats/standard_notes/) | <img src="https://www.synology.com/img/dsm/note_station/notestation_72.png" style="height:100px;max-width:100px;"><br>[Synology Note&nbsp;Station](https://marph91.github.io/jimmy/formats/synology_note_station/) |
| [Textbundle, Textpack](https://marph91.github.io/jimmy/formats/textbundle/) | <img src="https://talk.tiddlywiki.org/uploads/default/original/1X/5d4e8afa05b64280281f851dfc982796b5f7fcd1.svg" style="height:100px;max-width:100px;"><br>[Tiddlywiki](https://marph91.github.io/jimmy/formats/tiddlywiki/) | <img src="https://dl.flathub.org/media/org/gnome/Gnote/4f2ede31f33a5f935bec4206a6035410/icons/128x128/org.gnome.Gnote.png" style="height:100px;max-width:100px;"><br>[Tomboy-ng, Gnote](https://marph91.github.io/jimmy/formats/tomboy_ng/) | [vCard](https://marph91.github.io/jimmy/formats/vcard/) | <img src="https://raw.githubusercontent.com/Zettelkasten-Team/Zettelkasten/refs/heads/main/src/main/resources/de/danielluedecke/zettelkasten/resources/icons/zkn3-256x256.png" style="height:100px;max-width:100px;"><br>[Zettelkasten](https://marph91.github.io/jimmy/formats/zettelkasten/) |
| <img src="https://zim-wiki.org/images/globe.png" style="height:100px;max-width:100px;"><br>[Zim](https://marph91.github.io/jimmy/formats/zim/) | <img src="https://zohowebstatic.com/sites/default/files/ogimage/notebook-logo.png" style="height:100px;max-width:100px;"><br>[Zoho&nbsp;Notebook](https://marph91.github.io/jimmy/formats/zoho_notebook/) ||||

## Supported Formats

||||||
| :---: | :---: | :---: | :---: | :---: |
| <img src="https://avatars.githubusercontent.com/u/3137042?s=100&v=4" style="height:100px;max-width:100px;"><br>[Asciidoc](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/3/34/Microsoft_Office_Excel_%282019%E2%80%93present%29.svg" style="height:100px;max-width:100px;"><br>[CSV](https://marph91.github.io/jimmy/formats/default/) | [DocBook](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/f/fd/Microsoft_Office_Word_%282019%E2%80%93present%29.svg" style="height:100px;max-width:100px;"><br>[docx](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/9/91/Epub_logo.svg" style="height:100px;max-width:100px;"><br>[EPUB](https://marph91.github.io/jimmy/formats/default/) |
| <img src="https://fountain.io/wp-content/uploads/2023/05/fountain-sign-164-150x150.png" style="height:100px;max-width:100px;"><br>[Fountain](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/6/61/HTML5_logo_and_wordmark.svg" style="height:100px;max-width:100px;"><br>[HTML](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/3/38/Jupyter_logo.svg" style="height:100px;max-width:100px;"><br>[Jupyter Notebook](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/f/f4/Markdown-mark-4th.svg" style="height:100px;max-width:100px;"><br>[Markdown](https://marph91.github.io/jimmy/formats/default/) | <img src="https://www.mediawiki.org/static/images/icons/mediawikiwiki.svg" style="height:100px;max-width:100px;"><br>[MediaWiki](https://marph91.github.io/jimmy/formats/default/) |
| <img src="https://upload.wikimedia.org/wikipedia/commons/0/02/LibreOffice_6.1_Writer_Icon.svg" style="height:100px;max-width:100px;"><br>[ODT](https://marph91.github.io/jimmy/formats/default/) | <img src="https://upload.wikimedia.org/wikipedia/commons/2/2c/Opml-icon.svg" style="height:100px;max-width:100px;"><br>[OPML](https://marph91.github.io/jimmy/formats/default/) | [reStructuredText](https://marph91.github.io/jimmy/formats/default/) | [RTF](https://marph91.github.io/jimmy/formats/default/) | [txt2tags](https://marph91.github.io/jimmy/formats/default/) |

## General Usage

```mermaid
Expand All @@ -46,7 +65,7 @@ For detailed instructions, see the page of the [specific format](https://marph91

## Quickstart

1. Download jimmy here: [**Linux**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-linux) | [**Windows**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-windows.exe) | [**MacOS**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-darwin) [^macos]
1. Download jimmy here: [**Linux**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-linux) | [**Windows**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-windows.exe) | [**MacOS**](https://github.com/marph91/jimmy/releases/latest/download/jimmy-cli-darwin)
2. Examples for the Linux CLI app:

```bash
Expand All @@ -71,8 +90,6 @@ What is converted (in most cases)?

If something is not working, please check the issues first. If you can't find anything, feel free to create a new issue. It might be just not implemented yet or a regression. On the other side, the exported data can be sparse. In that case it's not possible to transfer the data with jimmy.

[^macos]: The MacOS app is untested.

## Demo

This is an example of a successful conversion:
Expand Down

0 comments on commit 1a81373

Please sign in to comment.