Skip to content

Latest commit

 

History

History
317 lines (227 loc) · 22.3 KB

README.md

File metadata and controls

317 lines (227 loc) · 22.3 KB
Raw

中文

Publisher

Publish articles from siyuan-note to platforms like Yuque etc. Free and open source.

If you're interested in the paid professional version, please check the paied ➡️ Publishing Tool Professional Edition

The latest Publish Tool version 1.20.0 is released🎉, potentially one of the most revolutionary iterations since the inception of first releases👀.

  • Notable inclusions within version 1.20.0 comprise the introduction of additional publishing platforms, an initial foray into supporting the docker version, along with enhancements tailored to optimize user interactions.

    • The prominent features integrated into 1.20.0 encompass:

      • #958 #1009 Experimental support for the docker edition of siyuan-note, marking a preliminary step towards its implementation. Should anomalies surface during deployment, the extension welcomes the addition of GitHub issues for resolution.
        • Please note: Unavailability of CORS proxy configuration will render the functionality inactive!!!
        • The image feature of the Picgo plugin is currently unavailable in the Docker version; support will be introduced in 1.20.1.
      • #1053 Introduction of the publishing platform telegra.ph
        • Please note: Unavailability of CORS proxy configuration will render the functionality inactive!!! Furthermore, accessing article previews mandates circumventing restrictions via appropriate means.
        • For discussions on CORS proxy complications or other inquiries, feel free to engage in group discussions or reach out to the author at youweics@163.com
        • At present, only anonymous posting and updates are supported; login functionality will be incorporated in version 1.20.1.
      • #1054 Addition of article management capabilities
        • Renamed article management as Dashboard. Feedback regarding nomenclature adjustments can be deliberated via issues, facilitating responsive modifications by the author.
        • Facilitation of displaying all platform publication icons
        • Provision for exhibiting the count of publishing platforms
        • Integration of filters for curated published articles

    • 1.20.0 predominantly refines the following areas of focus:

      • Incorporation of development documentation alongside a preview of forthcoming version agendas
      • Enhanced Plugin Store experience
      • Streamlined import processes, now accommodating customized imports
      • Exquisitely refined iteration of `sy-post-publisher widget

    • Furthermore, post the 1.14.0 version, the author discretely developed an import function. Users can swiftly import built-in platforms through Settings -> Publish Settings -> Import Platforms feature 😄

For further details, kindly click here to peruse the latest help documentation.

**Should you encounter any issues or wish to submit suggestions, feel free to join QQ group 895063267 for discussions. **

Version Preview

1.20.1-preview – As of Q1 2024

  • Support picture upload form picgo via docker
  • Expansion of telegra.ph support for image uploads
  • Support login for telegra.ph
  • Rectification of scenarios entailing repetitive image uploads across select platforms
  • Resolution of formatting discrepancies within WeChat public accounts
  • #990 Rectification of irregular display issues while posting to Jian Shu
  • #989 Failure in posting certain articles to Notion
  • Rectifying error scenarios during posting to WeChat public accounts in certain contexts
  • #948 #905 Corrections addressing halo platform-related concerns
  • Addressing vuepress2 related issues

1.21.0-preview – As of Q1 2024

  • Inclusion of support for BiliBili and Xiaohongshu platforms

1.22.0-preview – As of Q2 2024

  • Embracing compatibility for Evernote and Antora (including GitHub and GitLab)

1.23.0-preview – As of Q2 2024

  • Enabling support for Docsify (inclusive of GitHub and GitLab) and Douban

1.24.0-preview – As of Q2 2024

  • Integration with flowus platform

1.25.0-preview – As of Q2 2024

  • Extending support to Xlog, mdnice, and zola platforms

1.26.0-preview – As of Q3 2024

  • Collaborative interactions with #956 and OceanPress

Update history

Please check CHANGELOG

Development

Please refer to DEVELOPMENT

Platform List

Names not listed in order

Type Platform Status PC Client PC Image Upload Docker Docker Image Upload Note
Generic Yuque ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Generic Notion ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Generic Halo ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Generic Evernote TODO TODO TODO TODO TODO Official Website
Generic Github ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Hexo ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Hugo ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Jekyll ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Vuepress ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Vuepress2 ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Vitepress ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Static Site Generator Antora TODO TODO TODO TODO TODO Official Website
Static Site Generator Docsify TODO TODO TODO TODO TODO Official Website
Git Hosting Gitlab ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabhexo ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabhugo ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabjekyll ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabvuepress ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabvuepress2 ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabvitepress ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Git Hosting Gitlabantora TODO TODO TODO TODO TODO Official Website
Git Hosting Gitlabdocsify TODO TODO TODO TODO TODO Official Website
Blog Metaweblog ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Blog CnBlogs ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Blog Typecho ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Blog Jvue ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Blog WordPress ✔ Fully Compatible ✔ Partially Compatible ❌ Official Website
Social Media Zhihu ✔ Fully Compatible ✔ Partially Compatible, Requires PC Account Verification ❌ Official Website
Social Media CSDN ✔ Fully Compatible ✔ Partially Compatible, Requires PC Account Verification ❌ Official Website
Social Media WeChat Official Account ✔ Fully Compatible ✔ Partially Compatible, Requires PC Account Verification ❌ Official Website
Social Media Jianshu ✔ Fully Compatible ✔ Partially Compatible, Requires PC Account Verification ❌ Official Website
Social Media Juejin ✔ Fully Compatible ✔ Partially Compatible, Requires PC Account Verification ❌ Official Website
Community 52pojie TODO TODO TODO TODO TODO Official Website
Community Bilibili TODO TODO TODO TODO TODO Official Website
Community Xiaohongshu TODO TODO TODO TODO TODO Official Website
Community Douban TODO TODO TODO TODO TODO Official Website
Others Xlog TODO TODO TODO TODO TODO Official Website
Others Mdnice TODO TODO TODO TODO TODO Official Website
Others Flowus TODO TODO TODO TODO TODO Official Website
Others telegra.ph ✔ Partially Compatible ❌ Partially Compatible ❌ Official Website

Core Features

  • Rapid Publishing: One-time configuration, one-click publishing.
  • Image Hosting Management: Integrated with PicGO image hosting, supports s3, minio, watermark plugins. Requires installation of Picgo plugin from the marketplace. Currently only available for PC client.
  • Extension Support: Built on a unified blog API specification, with built-in metaweblogAPI, WordPress, Wechatsync, and Github support. Provides a unified adapter, theoretically extensible to any platform.
  • Platform Toggle: Enable or disable all platforms.
  • Dynamic Addition: Supports custom adding of platforms.
  • AI Integration: Integrates freeform chat and context-based chat based on the current document.
  • Intelligent Categorization: Supports intelligent slug aliases, intelligent titles, intelligent summaries, intelligent tags, intelligent categories.
  • Article Association: Supports linking existing platform articles to SiYuan notes for convenient future management. Supports one-way synchronization from SiYuan to platforms.
  • Theme Adaptation: Automatically adapts to dark mode and light mode.
  • Language Support: Multi-language support, including Chinese and English versions.
  • Publishing Views: Supports various publishing views - simple mode, detailed mode, and source code mode.
  • Multiple Deployment Options: Supports SiYuan Note plugin highly recommended, Chrome browser extension, and self-deployment.

This plugin promises that the basic functions will be free forever, and the follow-up related to intelligent AI may be charged, and the closed beta stage is completely free. If you want to support developers, please feel free to support here.

🌹 Tips: This plugin is an upgraded version of the original 'Siyuan Note Publishing Tool' widget, which includes all the functions provided by the original widget, provides a convenient menu operation entry, and has carried out a series of problem fixes and experience optimizations.

In addition to [Extended Functions], Other functions do not require any dependencies , and there is no need to download the previous widget, which is already built-in in the plugin.

Compatibility of Origin notes

This plugin is fully compatible with siyuan-note PC Client , due to limited personal energy, other devices are no longer supported.

Supported taxonomy

  • Classification

    • Multi-select classification

  • Knowledge space

    • Single-choice knowledge space
    • Tree-shaped radio knowledge space

  • tag

    • Multi-select tab

  • Label alias

    • Radio label alias

Platform Adaptation Plan

If you have a platform you want to use, but this tool has not yet been implemented, you can submit the Siyuan Note Publishing Tool Plugin Platform Adaptation Tracking Form , the developer will consider including it in the development plan.

For platform adaptation, please refer to Latest Adaptation

FAQ

  • Q1：How to install the publishing tool plugin? Where can I find his entrance after installation?

    A1：Find Bazaar->Plugins->Publishing Tools to download and enable.

    The installation process requires no further action. This is no different from the download and installation of other plugins.

    After the installation is complete, find the ✈️ icon on the top right toolbar, click the menu, and follow the corresponding instructions to use it.

  • Q2：After installing the publishing tool plugin, do I still need to install the widget?

    A2：unnecessary.

    The plugin version contains all the functions of the widget version.

  • Q3: I am not used to the new version of the operation and want to continue to use the previous widget, can I?

    A3:Yes but not recommended.

    We strongly recommend that you use the plug-in version directly, because the plug-in version will be the main version for long-term maintenance in the future, and the hanger version has been deprecated only as a fix for problems and compatible with historical users.

  • Q4：I used to use Custom JS Fragment or add WidgetInvoke directly, do I still need to download the plugin now?

    A4：Optional. But we highly recommended to remove JS snippets and widgets to download the plugin version.

    If you don't want to use the plugin version, you don't need to download it, just use the original custom JS fragment or add widget to continue using.

    If you want to use the plugin version, then we strongly recommend that you delete the previously added custom JS snippets and widgets, download the plugin version directly, and enable it. No other additional action is required.

  • Q5：Is it possible to migrate my historical configuration data items to the plugin?

  • A5：Yes.

    Please go to Settings->Import and Export->Import the historical data of the widget version. Operation.

    Note: The widget version configuration data import only supports sy-p-cfg-v0.8.0.json and picgo.json.

  • Q6：What should I do if the platform I need to publish is not provided by the publishing tool?

A6：Reference: Platform Adaptation Plan

Donate

If you approve of this project, invite me to have a cup of coffee, which will encourage me to keep updating and create more useful tools~

Wechat

wechat

Alipay

alipay

Afdian

https://afdian.net/a/terwer

Thanks

  • Thanks to the third-party framework for supporting the bottom layer of this project

    Names not listed in order

    | Name | version |vendor| |:-----------:|:-------:| :---------: | | turbo | 1.9+ |Vercel| | Vue | 3.3.4+ |Evan You| | Vite | 4.2+ |Evan You| | TypeScript | 5.0+ |Microsoft| | siyuan-note | 2.9.0+ |D,V|

  • Thanks to leolee9086 and ciwoyipang for the icon resource

  • Thanks to the enthusiastic support of the following users, I will continue to update and maintain the project!

    • 2023-09-04 *Xia Donate to [Publish Tool]

    • 2023-08-31 *Cheng Donate to [Publishing Tool] Thanks for providing the note posting tool, reminder change

    • 2023-08-31 *? Donated to [Publish Tool] Thanks for providing the siyuan-note Publish Tool.

    • 2023-08-14 *? Donated to [Publish Tool]

    • 2023-08-10 *f Donated to [Publish Tool] for liking the release plugin.

    • 2023-08-10 *2 Donated to [Publish Tool] to support the development of Source Release Plugin.

    • 2023-07-13 *Liang Donated to [Document Alias] Is it possible to expand the functionality to H1?

    • 2023-07-09 *z Donated to [Online Sharing] The online sharing plugin is great, thanks!

    • 2023-06-14 *Jun Donated to [Document Roaming] Thanks for the Document Roaming feature.

    • 2023-01-16 *Zhan Donated to [Import Tool] Finally, we can import epub files.

      If you do not want to display donation information, you can send an email directly to youweics@163.com.