Benature/omnivore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Some initial Markdown cleanup

Browse Source
This commit is contained in:
Jackson Harper
2022-10-02 20:24:35 +08:00
parent 14a8a8b735
commit b1fd079cac
1 changed files with 46 additions and 64 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
docs/guides/getting-started/en/getting-started-guide.md
View File

@ -5,21 +5,18 @@ Omnivore is a **read-it-later app** that lets you save and organize everything y
This guide will show you how to use Omnivore’s basic functions and advanced features, divided into four main activities:
* Saving
* Reading
* Organizing
* Integrations
The **Library **is the center of your Omnivore experience, where you can quickly access any links you have saved. Saved links remain in your Library forever unless you delete them.
The **Library **is the center of your Omnivore experience, where you can quickly access any links you have saved. Saved links remain in your Library forever unless you delete them.
**Saving **
**Saving**
There are five main ways to save links to pages or articles that you wish to read later:
There are five main ways to save links to pages or articles that you wish to read later:
@ -27,17 +24,17 @@ The **Library **is the center of your Omnivore experience, where you can quickly
* Saving from a Browser
* Saving from a Phone or Tablet (iOS or Android)
* Newsletter Subscriptions via Email
* Saving PDFs from a Mac \
* Saving PDFs from a Mac
**Saving from Your Omnivore Library** \
1. In the upper right corner of your Library, tap the **Add Link** button. \
2. Enter the URL you wish to save and tap **Add Link**. \
3. The link will appear in your Library the next time you refresh it. \
**Saving from Your Omnivore Library**
1. In the upper right corner of your Library, tap the **Add Link** button.
2. Enter the URL you wish to save and tap **Add Link**.
3. The link will appear in your Library the next time you refresh it.
**Saving from a Browser**
**Saving from a Browser** \
1. Download and install the Omnivore extension for your browser:
* [Chrome ](https://omnivore.app/install/chrome)
@ -45,61 +42,52 @@ The **Library **is the center of your Omnivore experience, where you can quickly
* [Firefox](https://omnivore.app/install/firefox)
* [Safari](https://omnivore.app/install/safari)
2. Navigate to the page you wish to save and tap the Omnivore button in your browser’s toolbar or Extensions menu. \
3. Alternatively, you can right-click (command+click on Mac) on any hyperlink and select **Save to Omnivore** from the menu. \
4. The link will appear in your Library the next time you refresh it. \
2. Navigate to the page you wish to save and tap the Omnivore button in your browser’s toolbar or Extensions menu.
3. Alternatively, you can right-click (command+click on Mac) on any hyperlink and select **Save to Omnivore** from the menu.
4. The link will appear in your Library the next time you refresh it.
**Saving from a Phone or Tablet**
**Saving from a Phone or Tablet**
The best way to save links from your mobile device is via the Omnivore app. You can download the app here:
The best way to save links from your mobile device is via the Omnivore app. You can download the app here:
* [iOS (iPhone or iPad)](https://omnivore.app/install/ios)
* Android \
* Android
Once the mobile app is installed:
Once the mobile app is installed:
1. In your browser, navigate to the page you wish to save and tap the **Share** button.
2. Tap the **Omnivore** icon in the Share menu.
3. The link will appear in your Library the next time you refresh it.
**Newsletter Subscriptions via Email** \
**Newsletter Subscriptions via Email**
1. On the Omnivore website or app, tap your photo, initial, or avatar in the top right corner to access the profile menu. Select **Emails** from the menu.
2. Tap **Create a New Email Address** to add a new email address (ex: username-123_abc@inbox.omnivore.app) to the list.
3. Click the Copy icon next to the email address.
4. Navigate to the signup page for the newsletter you wish to subscribe to. \
2. Tap **Create a New Email Address** to add a new email address (ex: username-123_abc@inbox.omnivore.app) to the list.
3. Click the Copy icon next to the email address.
4. Navigate to the signup page for the newsletter you wish to subscribe to. \
5. Paste the Omnivore email address into the signup form.
6. New newsletters will be automatically delivered to your Omnivore inbox.
6. New newsletters will be automatically delivered to your Omnivore inbox.
**Saving PDFs from a Mac **
**Saving PDFs from a Mac**
1. Install the [Mac App](https://omnivore.app/install/mac).
2. On your Mac, locate the PDF you wish to save and right-click or ctrl+click on the file name.
3. Select **Share** from the menu and choose **Omnivore**.
4. The link will appear in your Library the next time you refresh it.
**Reading**
**Reading**
Click any link saved in your Library to enter the Reader view.
Click any link saved in your Library to enter the Reader view.
Omnivore formats pages for easy reading and highlighting, removing ads and clutter for distraction-free reading. The text-focused view also makes articles smaller and quicker to load.
Omnivore formats pages for easy reading and highlighting, removing ads and clutter for distraction-free reading. The text-focused view also makes articles smaller and quicker to load.
While reading, you can:
While reading, you can:
* <span style="text-decoration:underline;">Change Formatting</span>
* <span style="text-decoration:underline;">Highlight Text</span>
@ -107,55 +95,49 @@ The **Library **is the center of your Omnivore experience, where you can quickly
* <span style="text-decoration:underline;">View All Saved Highlights and Notes</span>
* <span style="text-decoration:underline;">Track Reading Progress</span>
**Change Formatting **
**Change Formatting **
1. **_Theme:_** Tap your photo, initial, or avatar in the top right corner to access the profile menu. Select the white or black thumbnail to choose the Light or Dark theme.
2. **_Text Formatting:_** Tap the Aa icon to adjust the text size, font, margins, and line spacing.
**Highlight Text**
**Highlight Text**
1. Select the text you wish to highlight.
2. Tap the **Highlight **button.
3. The text will appear highlighted next time you view the article.
**Add Notes**
**Add Notes**
1. Highlight a section of text where you wish to add a note.
2. Tap the **Note** button, type your note, and tap **Save**.
3. The Note icon will appear next time you view this article.
**View All Saved Highlights and Notes**
**View All Saved Highlights and Notes**
1. Tap the Highlight/Note icon to see a list of all the highlighted text and notes you have added to this page.
2. To remove a note or highlight, select it from the list and tap the Trash icon.
**Track Reading Progress**
**Track Reading Progress**
Omnivore automatically keeps track of your reading progress across your different devices so you can easily pick up where you left off. A progress bar will appear at the top of each link in your Library after you have started reading.
Omnivore automatically keeps track of your reading progress across your different devices so you can easily pick up where you left off. A progress bar will appear at the top of each link in your Library after you have started reading.
**Organizing**
**Organizing**
By default, the Library inbox displays all links you have saved. To manage your list and keep your reading organized, Omnivore provides the following actions:
By default, the Library inbox displays all links you have saved. To manage your list and keep your reading organized, Omnivore provides the following actions:
* <span style="text-decoration:underline;">Archiving</span>
* <span style="text-decoration:underline;">Labels</span>
* <span style="text-decoration:underline;">Search</span>
* <span style="text-decoration:underline;">Filters</span>
**Archiving (Web)**
**Archiving (Web)**
1. Tap the Menu icon next to the link you wish to archive (on the mobile app, long press the link to open the menu).
2. Select **Archive**.
3. The link will disappear from the default Library view, but will show up if you select the Archived filter (see <span style="text-decoration:underline;">Filters </span>below).
**Archiving (Mobile App)**
1.
**Labels**
**Labels**
1. Tap the Menu icon next to any link and select **Set Label**s.
2. Select an existing label from the list or tap **Edit Labels** to create a new one.
@ -163,12 +145,12 @@ The **Library **is the center of your Omnivore experience, where you can quickly
4. _Omnivore mobile app only_: tap **Labels **to see a complete list of all labels you have used; tap one to view all links with the same label
5. Note: Omnivore will automatically assign some labels, such as “Newsletters.”
**Search**
**Search**
1. To search through all your saved links, enter a keyword or phrase in the search bar.
2. You can combine keywords with labels and filters to focus your search even further. [Learn more about advanced search](https://omnivore.app/help/search).
**Filters**
**Filters**
1. Use the **Filters **menu to refine your Library view (some filters may be visible by default).
2. Select **Read Later** to view a list of all your non-archived links except Newsletters.
@ -176,21 +158,21 @@ The **Library **is the center of your Omnivore experience, where you can quickly
4. Select **Today** to view a list of links you saved today.
5. Select **Newsletters** to view links saved via your newsletter subscriptions.
**Integrations**
**Integrations**
Omnivore allows integrations with knowledge bases and note-taking apps including:
Omnivore allows integrations with knowledge bases and note-taking apps including:
* Logseq
* Webhooks
**Logseq**
**Logseq**
With Omnivore's Logseq plugin you can sync all your saved articles, highlights, and notes into Logseq, a popular knowledge base. For information on setting up and using the Logseq plugin, please refer to this helpful [Omnivore for Logseq Plugin Guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide).
With Omnivore's Logseq plugin you can sync all your saved articles, highlights, and notes into Logseq, a popular knowledge base. For information on setting up and using the Logseq plugin, please refer to this helpful [Omnivore for Logseq Plugin Guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide).
**Webhooks**
**Webhooks**
Omnivore can trigger webhooks when you save a link or add highlights to a page you are reading. <span style="text-decoration:underline;">This example</span> shows webhooks being used to write all saved links to a Google Sheets spreadsheet stored on a Google Drive.
Omnivore can trigger webhooks when you save a link or add highlights to a page you are reading. <span style="text-decoration:underline;">This example</span> shows webhooks being used to write all saved links to a Google Sheets spreadsheet stored on a Google Drive.