Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Import Textbundle files #677

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion en/Getting started/Import notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Apps come and go, but your data should last. Obsidian uses non-proprietary plain
- <span class="icon-app icon-google-keep"></span> [[Import from Google Keep|Google Keep]]
- <span class="icon-app icon-bear"></span> [[Import from Bear|Bear]]
- <span class="icon-app icon-html"></span> [[Import HTML files|HTML files]]
- <span class="icon-app icon-md"></span> [[Import Zettelkasten notes|Zettelkasten notes]]
- <span class="icon-app icon-md"></span> [[Import Markdown files|Markdown files]]
- <span class="icon-app icon-md"></span> [[Import Textbundle files|Textbundle files]]
- <span class="icon-app icon-md"></span> [[Import Zettelkasten notes|Zettelkasten notes]]

## More formats

Expand Down
25 changes: 25 additions & 0 deletions en/Import notes/Import Textbundle files.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
permalink: import/textbundle
---
Obsidian allows you to easily migrate your notes from apps that support the [Textbundle](https://textbundle.org/) format using the [[Importer|Importer plugin]].

The Textbundle format bundles Markdown text and all referenced images into a single file, providing a more seamless way to move out of a sandboxed application. Textbundle export is supported by [many apps](https://textbundle.org/), including Agenda, Craft, Taio, Ulysses, Zettlr, and more.

## Import Textbundle files into Obsidian

You will need the official Obsidian [[Importer]] plugin, which you can [install here](obsidian://show-plugin?id=obsidian-importer).

1. Open **Settings**.
2. Go to **Community Plugins** and [install Importer](obsidian://show-plugin?id=obsidian-importer).
3. Enable the Importer plugin.
4. Open the **Importer** plugin using the command palette or ribbon icon.
5. Under **File format** choose **Textbundle (.textbundle, .textpack).**
6. Select the location of your Textbundle or Textpack files. Zip files are also supported.
7. Click **Import** and wait until import is complete.
8. You're done!

## Troubleshooting

### No files are selected for import

The textbundle import can only import one textbundle file at a time, and only on Mac devices. Instead, you may compress all of the textbundle files you wish to import into a single .zip file and import this instead from any device.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@kepano and @tgrosinger What do you think of:

On MacOS devices, the textbundle import will import one textbundle file at a time. To process multiple textbundle files at once, you will need to compress all of the textbundle files into a single .zip file before importing with Importer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we determine it happens on all Apple devices, we can adjust MacOS accordingly.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of saying it will import them one at a time, I would try to indicate that they will need to run the importer once for each file. They can't select more than one textbundle file at a time and have it just run through them.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 A slight change then. I am not sure how

On MacOS devices, Importer will process only one textbundle file per import. To process multiple textbundle files at once, you will need to compress all of the textbundle files into a single .zip file before importing with Importer.

Alternatively....

On MacOS devices, Importer will process only one textbundle file per import. Multiple individual textbundle files will require individual import attempts.

To more efficiently process multiple textbundle files at once, you will need to compress all of the textbundle files into a single .zip file before importing with Importer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of "will process" can we say "can only select"?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm fine with that. :)