Introduction Last updated: 2024-04-15

YNote is a note-taking app using EditorJS.

1.1 Introduction

YNote strives to provide an easy-to-use note-taking program. YNote uses EditorJS, transforming an otherwise regular text processing app to a highly-customizable platform with a large selection of components.

Blocks

Blocks refers to the different elements you can use from the toolbox.

2.1 List of blocks

Below is an overview of all blocks used in YNote.

Icon Name Description Credits
Text A regular paragraph of text
Heading A regular header (choice between 6 sizes)
Image Upload an image
Checklist An interactable checklist
Unordered List A dotted list with level support
Ordered List A numerical list with level support
Nested List A nested list with finer levels (closer spacing)
Attachment Upload an attachment
Table Create a table
Alert Coloured text box
Link Enter a URL, shows URL preview as title and description
- Delimiter A full-width solid thin line YNote Block
Colored Bar A configurable colored strip YNote Block
PDF Upload and embed a PDF file. If the browser does not support inline PDF viewing, a download button will be shown instead.
Date Current date in format: 12/06/2024 - 16:07 YNote Block
Date (Small) Current date in format: 12/06/2024 - 16:07 in smaller gray text YNote Block
Long Date Current date in format: Wednesday, 12 June 2024     16:07 YNote Block
Long Date (Small) Current date in format: Wednesday, 12 June 2024     16:07 in smaller gray text YNote Block
Math Math composer using LaTeX
mermaid Diagramming and charting tool using Mermaid
InlineImage Image by URL
CodeFlask Code box with language highlighting and line numbers
Raw HTML Black and gray basic code box
Warning Message box with title and message
Quote Message box with quote and author
Code Basic code box, gray on light gray

2.2 YNote Blocks

Below is an overview of all blocks custom made by YNote.

Icon Name Description Credits
- Delimiter A full-width solid thin line YNote Block
Colored Bar A configurable colored strip YNote Block
Date Current date in format: 12/06/2024 - 16:07 YNote Block
Date (Small) Current date in format: 12/06/2024 - 16:07 in smaller gray text YNote Block
Long Date Current date in format: Wednesday, 12 June 2024     16:07 YNote Block
Long Date (Small) Current date in format: Wednesday, 12 June 2024     16:07 in smaller gray text YNote Block

Saving

Saving your notes is one of the most important parts of note-taking. YNote makes this easy and manageable.

3.1 Export options

YNote offers the following export options under the 'Export' dropdown button.

  • Export Note (.ynote)
  • Export Notes (.ynotes)
  • Export Encrypted Note (.ynote.enc)

'Export Note' downloads the note you have currently opened as .ynote

'Export Notes' downloads all your tabs as .ynotes

'Export Encrypted Note' downloads the note you have currently opened as .ynote.enc, encrypted with AES-256 and encoded using Base64. This file can only be opened in YNote.

3.2 Importing

You can import notes using one of the following options under the 'Import' dropdown button.

  • Import Note (.ynote)
  • Import Notes (.ynotes)
  • Import Encrypted Note (.ynote.enc)

3.3 Filetypes

YNote uses the following file extensions.

Icon Name Description
- .ynote A YNote Note file.
- .ynotes A YNote Note Collection file. Contains multiple notes.
- .ynote.enc Encrypted YNote Note file. Proprietary: Can only be viewed in YNote.

Account

With a YNote Account, you can manage and customize your notes to an even greater extend.

4.1 Notebooks

YNote offers notebooks. These are essentially collections of multiple notes.

Notebooks can be given a name and a color.

On the Account page, you can see an overview of all your notebooks. This page also allows you to edit, export and delete notebooks.

Exported notebooks will be saved in the '.ynotes' file format. The content of an exported YNote Notebook looks like:

{ "notebook": { "name": "Example", "color": "#ff0000", "created": "2024-06-18 22:10:34" }, "notes": [ { "title": "My note", "color": "#00ff00", "content": "{\"time\":1718748864858,\"blocks\":[{\"id\":\"ddzINDT1Zf\",\"type\":\"paragraph\",\"data\":{\"text\":\"This is an example note.\"}}],\"version\":\"2.29.1\"}", "date": "2024-06-18 22:10:45" } ] }


Deleting a notebook will also delete all notes within it. These cannot be restored.

4.2 Notes

You can create notes within a notebook. Open a notebook by clicking on one on the Account page.

This will open a page: https://kiyantk.nl/dev/ynote/notebook/[notebook id]/

Here you will find the notebook title, a list of all notes within the notebook and a button to create a new note.

Creating a new note will open a new editor. By default, new notes are titled 'New note' and receive a white color.

On the right, you will see your currently opened note. Along with the editor, you also have the topbar options 'Export', 'Import', 'Convert', 'Readonly' and 'Disable Embed Services'.

You also find input fields for your current note right above the editor. Here you can change your note's title, color and save the note.

Changes to the title and color automatically save and update on your screen. Any work within the note's content (in the editor), is NOT automatically saved.

The export and import tabs offers the following options: Export/Import Note (.ynote) and Export/Import Encrypted Note (ynote.enc).

As explained before, the left side of the screen contains a list of the notes within the notebook. Clicking on one will open it. Each row also features a delete button, which deletes the note.

Other

This section is related to some miscellaneous information about YNote.

5.1 Converting

YNote offers the following conversion options under the 'Convert' dropdown button.

  • Convert TXT to YNOTE

5.2 Limits

The following limits apply in YNote.

  • File uploads cannot exceed 10MB. Files up to 10MB are allowed. This only applies to file uploads to the server using blocks like Attachment or PDF. No limits apply to importing YNotes.

5.3 Auto-Embed

Pasting the following URLs into YNote will automatically embed them within an iframe for seamless integration.

This functionality is brought to you by https://github.com/editor-js/embed

  • Youtube: Youtube Video's
  • Facebook: Facebook posts
  • Instagram: Instagram posts
  • Twitter (X): Twitter posts
  • Twitch: Videos and Channels:
  • Miro
  • Vimeo: Vimeo Video's
  • Gfycat
  • Imgur
  • Vine
  • Aparat
  • Yandex.Music: Tracks, Albums and Playlists
  • Coub
  • CodePen
  • Pinterest
  • GitHub Gist
  • Kiy.li Paste

If you want to paste links as text, instead of embedding, consider the following methods:

  • RECOMMENDED Press 'Disable Embed Services' in the topbar: Pressing this button will close your current tab, open a new tab and copy the content of your old tab into the new tab. The new tab is running an editor with Embed removed. Pasting links like https://youtube.com/watch?v=a1b2c3d4 will just paste as text.
  • Header: Only links pasted into Paragraph (Text) blocks will be converted. You can paste the URL into a Header block, and then use the Inline Toolbar to 'Convert to' > 'Text'.
  • Change paste: You can add something in front of the URL before pasting, such as .https://youtube.com/watch?v=a1b2c3d4
  • Manually type: Typing a supported URL will not create an Embed. Only pasting.

Note: Any supported Embed links will not be automatically converted to an embed upon importing a .ynote file. If you see an embed, the export will contain the embed. If you see just text, the export will contain just text. Consistency is important to us, so we try our hardest to keep the output of a .ynote the same.