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

FR: [Support for exporting notes and highlights to SiYuan Notes] #11580

Closed
isPoto opened this issue Mar 21, 2024 · 4 comments
Closed

FR: [Support for exporting notes and highlights to SiYuan Notes] #11580

isPoto opened this issue Mar 21, 2024 · 4 comments

Comments

@isPoto
Copy link

isPoto commented Mar 21, 2024

I found that Export Notes and Highlights currently supports 6 online services, all of which are note-taking software.

I would like to support SiYuan Notes, which is a Notion-like note-taking software that works very well, I use it myself!

https://b3log.org/siyuan/en/

@pazos
Copy link
Member

pazos commented Mar 21, 2024

Documentation: https://github.com/siyuan-note/siyuan/blob/master/API.md

It looks like the endpoint listens on localhost. Could you ask their devs if the API is available from remote machines, @isPoto?

If the API is intended to be used on the same machine as the note taking app then I would hard vetto it as it would involve the same workarounds we currently use for joplin.

I'm also planing to deprecate joplin when nextcloud note is available (#11522) since the setup sucks badly and it is not very useful for us in its current state.

Otherwise the app looks good and ticks all the checkboxes for an inclusion here: self-hostable, AGPL

@isPoto
Copy link
Author

isPoto commented Mar 21, 2024

SiYuan Notes is divided into two versions, one is completely local software (with official cloud synchronization or webdav). A Docker version that is fully hosted on a server, i.e. Cloud Notes

If you want to use it on a remote machine, you need to have your own Docker deployment and some additional configuration on Koreader, but this is too high a threshold for ordinary users.

The official cloud synchronization of SiYuan Notes is only for user data transfer, and does not accept external import.

So the API will be imported from the same machine

@pazos
Copy link
Member

pazos commented Mar 21, 2024

ok, thanks.

That's a pitty

@pazos pazos closed this as not planned Won't fix, can't repro, duplicate, stale Mar 21, 2024
@isPoto
Copy link
Author

isPoto commented Mar 21, 2024

Correcting previous mistakes

Siyuan Notes official reply: API support for remote machines

The development documentation is in the built-in tutorial of SiYuan Notes, inbox section.

Overview

We can collect external data through the cloud inbox, and then obtain these data from the cloud through the inbox panel in SiYuan and send them to the notebook for further sorting.

How to use

Currently, the following methods are provided for data access.

API

  • POST https://liuyun.io/apis/siyuan/inbox/addCloudShorthand

  • Body

    {
        "title": "A simple text title",
        "content": "Content with **Markdown**."
    }
  • The authentication method is the HTTP request header Authorization, the value is token {Your API Token} (note case and spaces), API Token can be found at [LiuYun - Settings - Account](https://liuyun.io/settings/account)

#Note#:

  • Frequency limit: Up to 128 inserts per 24 hours

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants