Skip to content

Commit

Permalink
Merge changes from main to develop (#143)
Browse files Browse the repository at this point in the history
* chore(release): 1.13.6

## [1.13.6](v1.13.5...v1.13.6) (2023-10-02)

### Bug Fixes

* allow users to use {{currentDate}} as the page name ([948e909](948e909))

* Translate language & plugin settings improvement (#142)

* feat(Add): logseq-l10n & ja-JP & plugin settings improvement

* feat(Add): Translation zh-CN (Chinese)

I don't understand Chinese. I had ChatGPT translate it based on the Japanese translation I made earlier. So please do the validation for this without me.

* Improvement of “README”, Japanese translation

---------

Co-authored-by: semantic-release-bot <[email protected]>
Co-authored-by: YU <[email protected]>
  • Loading branch information
3 people authored Oct 20, 2023
1 parent 18016b6 commit ab63064
Show file tree
Hide file tree
Showing 10 changed files with 5,201 additions and 92 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
## [1.13.6](https://github.com/omnivore-app/logseq-omnivore/compare/v1.13.5...v1.13.6) (2023-10-02)


### Bug Fixes

* allow users to use {{currentDate}} as the page name ([948e909](https://github.com/omnivore-app/logseq-omnivore/commit/948e909740389c20eecf87ec3f7903c119b04469))

## [1.13.5](https://github.com/omnivore-app/logseq-omnivore/compare/v1.13.4...v1.13.5) (2023-09-26)


Expand Down
72 changes: 72 additions & 0 deletions README.ja.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
[English](https://github.com/omnivore-app/logseq-omnivore)

# Logseq Plugin: *Omnivore*

このプラグインは、Webアプリ[Omnivore.app](https://omnivore.app/)(そのサーバー)にある、Webクリップの記事やそのハイライトなどをLogseqのグラフにインポート、同期します。

## 「Omnivore.app」を利用する

[Omnivore.app](https://omnivore.app)アカウントにサインアップします。
- 「Omnivore.app」というサイトは、Webクリップのためのツール(Webアプリ)です。気になったページをただ「ブラウザのお気に入りに登録する」のではなく、Webクリップとして管理します。気になった個所などハイライトとともに、複数のサイトを整理して保存します。
- このアプリは、デスクトップとモバイル、どちらからも無料で利用できます。Webクリップのデータはサーバー(クラウド)上に保存されます。このプラグインでは、それをLogseqに取り込んで保存します。その記事につけたノートも取り込みできます。

### ショーケース

* 日付ごと: Logseq上では、Webクリップされた日付、ハイライトされた日付など、日付ごとに自動的に分類されます。
* 分類と参照: Webクリップにつけたラベルは、タグとしてリンクが機能します。そのため、Webクリップしたページやそのハイライトを、既存のページに関連付けることができます。(そのページの"Linked References"に表示されます。)
> Omnivore.appでラベル付けをして、それらの記事をグループ化できます。そのラベルが、Logseqグラフにあるページへリンクするのと同じ役割をもちます。ただし、Omnivore.appからLogseqに取り込んだ記事に限ります。
* フィルタリング: [高度な検索構文](https://docs.omnivore.app/using/search.html)を使用して、記事データに基づくフィルタリングが可能
* Webクリップの保存先として: Omnivore.appからの記事データに基づいたグラフを作成
> 既存のグラフに入れる場合、新規グラフに入れる場合など
* カスタム: 記事データ用のカスタムテンプレート

## 使用方法

1. 通常、マーケットプレースからプラグインをインストールします。
1. プラグインがオンになると、APIキーの発行ページが開きます。 (Omnivoreの[APIキー発行ページ](https://omnivore.app/settings/api))
1. プラグイン設定画面を開いて API キーを登録します。
1. 右上のツールバーにある🔨ボタンを押して、Omnivoreのツールバーアイコンを有効にします。そのアイコンボタンを押すと[[Omnivore]]ページが開きます。そのとき、同期が開始されます。少し時間がかかる場合があります。
> Omnivore.appのINBOXに記事が存在しない場合は、記事を1つも取り込むことができません。先に、Omnivore.appのINBOXに記事をいれてください。
## 同期について

1. プラグインは「Omnivore」という専用ページを作成して同期をおこないます。
1. Omnivore.appでハイライトをつけたコンテンツ、および追加したノートが記事ブロック内に、挿入されます。プラグイン設定のカスタムテンプレートが適用されます。その属性データとラベルリンクが含まれます。
1. 同期のタイミング: プラグインを開いたときと、設定変更をおこなうたびに、Omnivore.appとの同期を開始します。
> さらにプラグイン設定で、API キー、検索フィルタ、プラグインがOmnivore.appとどれくらい頻繁に同期するかを変更できます。ツールバーのOmnivoreアイコンをクリックして、手動でOmnivore.appと同期することもできます。
## デモ

### 記事の同期

![取得中](screenshots/fetching.gif)

### プラグイン設定

![設定](screenshots/settings.gif)

## 連絡先

開発者: [Hongbo Wu](https://github.com/sywhb)[Omnivore](https://github.com/omnivore-app)

日本語の翻訳者: [YU000jp](https://github.com/YU000jp)

## 貢献

- Omnivore.app およびこのプラグインの使用方法に関する素晴らしい[ガイド](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5)を提供してくれた[@Brian](https://twitter.com/Bsunter)に感謝します。[中国語翻訳](https://sywhb.github.io/#/page/omnivore-logseq%20指南)[@吴洪博](https://twitter.com/Sy98715020)によって提供されました。

プルリクエストは歓迎されています。大規模な変更については、まず問題を開いて変更内容を議論してください。

## ライセンス

[MIT](https://choosealicense.com/licenses/mit/)

## FAQ

### 記事を取得しようとしたときに `TypeError: Cannot read properties of null (reading: 'uuid')` と表示されます。

この問題はプラグインの最新バージョンで修正されています。それにもかかわらず、この問題が引き続き発生する場合は、「Omnivore」ページの空のブロックをクリックしてみてください。

### Omnivore との同期ボタンが設定を更新した後に動作しません。

この問題はプラグインの最新バージョンで修正されています。それにもかかわらず、この問題が引き続き発生する場合は、プラグインを再読み込みしてみてください。それでも動作しない場合は、問題を開いてください。
56 changes: 33 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,58 @@
[日本語](https://github.com/omnivore-app/logseq-omnivore/blob/develop/README.ja.md)

# logseq-omnivore

This plugin imports your saved [Omnivore](https://omnivore.app/) articles and highlights into Logseq.
This plugin enables importing and syncing web clippings, articles, and highlights from the web app [Omnivore.app](https://omnivore.app/) (its server) into a Logseq graph.

## Features
## Utilizing "Omnivore.app"

* Import your highlights and saved article
* Create graphs based on Omnivore data
* Filter imported data using Omnivores [advanced search syntax](https://docs.omnivore.app/using/search.html)
* Custom templates for imported data
1. Register for an account on [Omnivore.app](https://omnivore.app).
- "Omnivore.app" functions as a web tool (web app) specifically designed for web clippings. Instead of simply bookmarking interesting pages in a browser, users can manage them as web clippings, alongside highlights, and organize multiple sites.
- This application is available for free on both desktop and mobile devices, and web clipping data is stored on the server (cloud). With this plugin, one can import and save this data in Logseq. Additionally, any attached notes related to the articles can also be imported.

## Installation
### Showcase

1. Install the plugin from the marketplace or build it from source and load unpacked plugin
2. Sign up for an [Omnivore account](https://omnivore.app)
3. Go to [Omnivore](https://omnivore.app/settings/api) and Create an API key
4. Open settings and add your api key
* Sorted by Date: In Logseq, web clippings and highlights are automatically categorized based on their respective dates.
* Tagging and Referencing: Labels attached to web clippings act as tags with links, allowing users to associate web-clipped pages and their highlights with existing pages (displayed in the "Linked References" section of the page).
> Labeling can be done in Omnivore.app, permitting users to group articles. These labels serve the same role as linking to pages within the Logseq graph but only for articles imported from Omnivore.app to Logseq.
* Filtering: Article data can be filtered using [advanced search syntax](https://docs.omnivore.app/using/search.html).
* As a Storage Location for Web Clippings: Create a graph based on article data from Omnivore.app.
> Whether one wants to add it to an existing graph or create a new one.
* Customization: Custom templates for article data.

## Usage
## Usage Instructions

1. The plugin will automatically sync with Omnivore every time you open the plugin and every time you change the settings
2. You can also manually sync with Omnivore by clicking the Omnivore icon on the toolbar
3. You can also change the API key, the search filter, and how often the plugin syncs with Omnivore by updating the settings
4. The plugin creates a new page named "Omnivore" and a block for each saved article including metadata, labels. Content you have highlighted in Omnivore, and any notes you added, will be nested
in the article block
5. Clicking on the article will open the Omnivore article in a new tab
6. We also create an internal link to each label in the article so you can group articles by label
7. Kudos to [@Brian](https://twitter.com/Bsunter) for the great [guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5) on how to use Omnivore and the plugin. [Chinese translation](https://sywhb.github.io/#/page/omnivore-logseq%20指南) by [@吴洪博](https://twitter.com/Sy98715020)
1. Typically, the plugin is installed from the marketplace.
1. Once the plugin is enabled, the API key issuance page will open (Omnivore's [API Key Issuance Page](https://omnivore.app/settings/api)).
1. Open the plugin settings and register the API key.
1. Click the 🔨 button in the top right toolbar to enable the Omnivore toolbar icon. Clicking that icon opens the [[Omnivore]] page, and synchronization begins at that point. This process may take some time.
> If there are no articles in Omnivore.app's INBOX, importing articles won't be possible. Therefore, it's recommended to add articles to Omnivore.app's INBOX first.
## Demo
## Synchronization Details

### Settings
1. The plugin generates a dedicated page named "Omnivore" for synchronization.
1. Content with highlights and additional notes added in Omnivore.app is inserted into article blocks, and custom templates from the plugin settings are applied. This includes attribute data and label links.
1. Synchronization Timing: Synchronization with Omnivore.app starts when the plugin is opened and whenever changes are made to the settings.
> Moreover, adjustments to the API key, search filters, and synchronization frequency can be made in the plugin settings. Manual synchronization with Omnivore.app can also be initiated by clicking the Omnivore icon in the toolbar.
![settings](screenshots/settings.gif)
## Demo

### Fetching

![fetching](screenshots/fetching.gif)

### Settings

![settings](screenshots/settings.gif)

## Contacts

Developer: [Hongbo Wu](https://github.com/sywhb) @ [Omnivore](https://github.com/omnivore-app)

## Contributing

- Kudos to [@Brian](https://twitter.com/Bsunter) for the great [guide](https://briansunter.com/graph/#/page/omnivore-logseq-guide?anchor=ls-block-62b28de3-0e9e-456e-bf29-7e2541213aa5) on how to use Omnivore.app and this plugin. [Chinese translation](https://sywhb.github.io/#/page/omnivore-logseq%20指南) by [@吴洪博](https://twitter.com/Sy98715020), Japanese translation by [YU000jp](https://github.com/YU000jp)

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License
Expand Down
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "logseq-omnivore",
"version": "1.13.5",
"version": "1.13.6",
"description": "Import Omnivore highlights and articles into Logseq.",
"main": "dist/index.html",
"targets": {
Expand Down Expand Up @@ -28,6 +28,7 @@
"date-fns": "^2.29.3",
"diff-match-patch": "^1.0.5",
"lodash": "^4.17.21",
"logseq-l10n": "^0.2.0",
"luxon": "^3.2.1",
"markdown-escape": "^1.1.0",
"mustache": "^4.2.0",
Expand Down
Loading

0 comments on commit ab63064

Please sign in to comment.