Merge pull request #205 from omnivore-app/jacksonh/exporter

Add documentation for the exporter tool

docs/.vitepress/locales/en.ts

@@ -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",

docs/using/exporting.md

@@ -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.