Introduction
Welcome to Butterfly, the opensource note app.
Butterfly is a note taking app that is aiming for unified experience across all platforms. It provides simple UI with powerful customization.
Getting started
You can use the sidebar to navigate quickly through the wiki.
To start working on the app you have two options:
- Downloads the app version that is appropriate for your platform (Butterfly can run on most mobile, desktop, and web platfroms).
- Use web version if you cannot find your platform or if you don't want to install it on it. See here about file storage on the web version.
Once you open the app, continue reading.
Main view
The main view is composed of several elements
- Desktop
- Mobile
The top of the screen holds the banner for updates, the link to this documentations, and the config icon. Finally, to the right of the config symbol you have a drop down menu for controlling when this banner will appear (always/never/on updates).
The "Files" section in the major area of the left. There, you can do the typical operations:
- Select the display type (grid or list)
- Select the source storage of the files
- Sort the display order of the files
- Add a folder, file, template, or import files by clicking the plus sign
- Type the direct path to a desired location (the Location field),
- Search for files Finally, to the right, you have the quick start display with the templates available in the current location. For a fresh install this includes the light and dark template
When opening Butterfly on a mobile device you will be presented with a screen as this
The top of the screen holds the banner for updates, and below it you can find the documnentation link, and next to it the config icon. Finally, to the right of the config symbol you have a drop down menu for controlling when this banner will appear (always/never/on updates).
Below those, you can find the quick start section holding the templates avialable to you. By defaule, the templates are the light and dark templates.
Scrolling down, you will see the file interface:
The "Files" section in the major area of the left. There, you can do the typical operations:
- Select the display type (grid or list)
- Select the source storage of the files
- Sort the display order of the files
- Add a folder, file, template, or import files by clicking the plus sign
- Type the direct path to a desired location (the Location field),
- Search for files
Once opening a document by selecting a template or an existing file, you will get to the Document View
The Document View
You can return from the document view to the document list with the back action of your device. As with the main view, the document display changes based on your device.
- Desktop
- Mobile
In the Desktop view, you'll have at the top left the file bar
This holds, from left to right, the
butterfly button to open the menu. Next to it there is the name field that displays the name of the note. You can rename the note by typing a new name into that field and saving it using the save button. Finally you can search for elements within the note.
At the top right of the screen you have the toolbar
By default this bar has the lasso tool; the pen tool; the path erase tool; the undo and redo butons, and the hand tool. Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen.
Important notes
- If some of the element on the toolbar are not visible to you, click and drag (or swipe) left and right to reveal further tools.
- After selecting a tool, a small menu will appear. Long clicking the tool again will allow you to drag it to a new position
- You can add more tools to the toolbar by clicking the plus sign.
In the mobile view, you'll have at the top the file bar
This holds, from left to right, the
butterfly button to open the menu. Next to it there is the name field that displays the name of the note. You can rename the note by typing a new name into that field and saving it using the save button. Finally you can search for elements within the note.
At the bottom of the screen you have the toolbar
By default this bar has the lasso tool; the pen tool; the path erase tool; the undo and redo butons, and the hand tool. Then you have the button to add elements to the tool bar, the button to configure the document, and finally the tool to look the zoom and/or the position of the screen.
Important notes
- If some of the element on the toolbar are not visible to you, or swipe left and right to reveal further elements.
- After selecting a tool, a small menu will appear to configure the it. Long clicking the tool again will allow you to drag it to a new position
- You can add more tools to the toolbar by clicking the plus sign.