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.

Sign up for GitHub

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

Add documentation for the exporter tool #205

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Add documentation for the exporter tool #205

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions docs/.vitepress/locales/en.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ export const themeConfig: DefaultTheme.Config = {
{ text: "Saved Searches", link: "/using/saved-searches" },
{ text: "Rules", link: "/using/rules" },
{ text: "Importing Data", link: "/using/importing" },
{ text: "Exporting Data", link: "/using/exporting" },
{ text: "Keyboard Commands", link: "/using/keyboard" },
{
text: "Managing your Account",
Expand Down
26 changes: 26 additions & 0 deletions docs/using/exporting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Exporting your data
editLink: true
---

# {{ $frontmatter.title }}

The best way to export your data is to use the Obsidian client to sync all of your data into an Obsidian vault. If you are not familiar with Obsidian you can use our exporter tool to export all of your links, highlights, and saved page content.

[[toc]]

## Exporting with the exporter tool

To use the exporter tool you will need to login to your account online at [https://omnivore.app/login](https://omnivore.app/login). Once you have done this, navigate to your account page by opening the menu and clicking on your user name. You can access the page directly [here](https://omnivore.app/settings/account).

On the account page click the `Export Data` button. This will gather all of your saved links, their page content, and your highlights into a single zip file. This can take some time depending on your account size, but you should receive an email once the process has started. Usually within 30 minutes of clicking the Export button. The entire process can take about 1hr per-1000 saved items.

Once completed, you will receive an export link in your email. This link is valid for 24hrs and can be used to download all your data.

### Export archives

The archive will contain a few items:

1. `./contents/*.html`: this is all of the content of your saved pages
2. `./highlights/*.md`: this is all of your highlights saved in markdown format. The slug attribute from your metadata is used as the filename.
3. `metadata_*.json`: Metadata files for all your saved items. These are provided in batches of 20 items. So items 0-20, 20-40, etc.
Loading