Git Product home page Git Product logo

terwer / siyuan-plugin-publisher Goto Github PK

View Code? Open in Web Editor NEW
101.0 101.0 8.0 55.26 MB

✈️ Publish articles from siyuan-note to platforms such as Yuque, etc.Free and open source. 将思源笔记的文章发布到语雀等平台,开源免费。

Home Page: https://publish.terwer.space

License: MIT License

TypeScript 63.28% JavaScript 0.87% Python 3.00% Stylus 0.10% HTML 0.02% Vue 32.29% CSS 0.44%
blog chrome-extension confluence edge-extension firefox-addon jvue metaweblog metaweblog-api publish siyuan siyuan-note typescript vue vue3 vuepress widget wordpress

siyuan-plugin-publisher's Introduction

中文

Publisher

logo

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

Please click here to see the latest docs, it updates in real time.

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

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

Update history

Please check CHANGELOG

Development

Please refer to DEVELOPMENT

Platform List

The sequence is insignificant

Note: Image upload availability refers to the installation of PicGo plugin1.9.0+ and accurate configuration.

Type Platform Status PC Client PC Image Upload Docker Docker Image Upload Platform Image Upload Docker Proxy PC Proxy Note
Generic Yuque Compatible Compatible Not Supported Bundled Proxy No Official Website
Generic Notion Compatible Compatible Not Supported Bundled Proxy No Official Website
Generic Halo Compatible Compatible Supported Bundled Proxy No Official Website
Generic Evernote TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Generic Github Compatible Compatible Supported No No Official Website
Static Site Generator Hexo Compatible Compatible Supported No No Official Website
Static Site Generator Hugo Compatible Compatible Supported No No Official Website
Static Site Generator Jekyll Compatible Compatible Supported No No Official Website
Static Site Generator Vuepress Compatible Compatible Supported No No Official Website
Static Site Generator Vuepress2 Compatible Compatible Supported No No Official Website
Static Site Generator Vitepress Compatible Compatible Supported No No Official Website
Static Site Generator Antora TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Static Site Generator Docsify TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Git Hosting Gitlab Compatible Compatible Supported No No Official Website
Git Hosting Gitlabhexo Compatible Compatible Supported No No Official Website
Git Hosting Gitlabhugo Compatible Compatible Supported No No Official Website
Git Hosting Gitlabjekyll Compatible Compatible Supported No No Official Website
Git Hosting Gitlabvuepress Compatible Compatible Supported No No Official Website
Git Hosting Gitlabvuepress2 Compatible Compatible Supported No No Official Website
Git Hosting Gitlabvitepress Compatible Compatible Supported No No Official Website
Git Hosting Gitlabantora TODO TODO TODO TODO TODO Supported TODO TODO Official Website
Git Hosting Gitlabdocsify TODO TODO TODO TODO TODO Supported TODO TODO Official Website
Blog Metaweblog Compatible Compatible Supported Bundled Proxy No Official Website
Blog CnBlogs Compatible Compatible Supported Bundled Proxy No Official Website
Blog Typecho Compatible Compatible Supported Bundled Proxy No Official Website
Blog Jvue Compatible Compatible Supported Bundled Proxy No Official Website
Blog WordPress Compatible Compatible Supported Bundled Proxy No Official Website
Blog WordPress.com Compatible Compatible Supported Custom Proxy Custom Proxy Official Website
Social Media Zhihu Fully Compatible Requires PC Auth or Cookie Supported Bundled Proxy No Official Website
Social Media CSDN Fully Compatible Requires PC Auth or Cookie Supported Bundled Proxy No Official Website
Social Media WeChat Official Account Fully Compatible Cookie Supported Bundled Proxy No Official Website
Social Media Jianshu Fully Compatible Requires PC Auth or Cookie Supported Bundled Proxy No Official Website
Social Media Juejin Fully Compatible Requires PC Auth or Cookie Not Supported Bundled Proxy No Official Website
Community 52pojie TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Community Bilibili TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Community Xiaohongshu TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Community Douban TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Others Xlog TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Others Mdnice TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Others Flowus TODO TODO TODO TODO TODO TODO TODO TODO Official Website
Others telegra.ph Fully Compatible Fully Compatible Not Supported Custom Proxy Custom Proxy 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 siyuan-note

This plugin is fully compatible with siyuan-note PC client, Docker version 1.20.2+, and mobile clients ( Android, iOS) 1.20.2+.

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

Version Preview

1.21.3-preview – As of Q1 2024

  • Expansion of telegra.ph support for image uploads
  • 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.4-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

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!

    • 2024-03-31 *Ren Donated to [Publish Tool]

    • 2024-03-22 *Ming Donated to [Publish Tool]

    • 2024-03-05 *ruler Donated to [Publish Tool]

    • 2024-03-12 *? Donated to [Publish Tool]

    • 2024-03-04 *azar Donated to [Publish Tool]

    • 2024-02-28 *Zhao Donated to [Publish Tool]

    • 2024-01-15 Zi* Donated to [Publish Tool]

    • 2024-01-09 Zi* Donated to [Publish Tool]

    • 2023-11-12 S* Donated to [Publish Tool]

    • 2023-10-15 *Xian Donated to [Publish Tool]

    • 2023-09-04 *Xia Donated 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 [email protected].

siyuan-plugin-publisher's People

Contributors

cesaryuan avatar dependabot[bot] avatar github-actions[bot] avatar terwer avatar yuezhangcs avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

siyuan-plugin-publisher's Issues

feat:导入Element-Plus框架

yarn add element-plus

疑问:
ts的setup与js的data、methods的区别

下面的 setup 语法等价于

  setup() {
    const {locale} = useI18n()
    const langs = [
      {
        value: 'zh_CN',
        label: "简体中文"
      },
      {
        value: 'en_US',
        label: "English"
      }
    ]

    function langChanged(lang: string) {
      console.log("langChanged=>", lang);
      localStorage.Lang = lang;
      locale.value = lang;
    }

    // 设置默认语言
    if (localStorage.Lang != null) locale.value = localStorage.Lang;

    return {langs, langChanged}
  },

这种

data() {
    return {
      langs: [
        {
          value: 'zh_CN',
          label: "简体中文"
        },
        {
          value: 'en_US',
          label: "English"
        }
      ]
    }
  },
  methods: {
    langChanged(lang) {
      console.log("langChanged=>", lang);
      localStorage.Lang = lang;
    }
  },
  mounted() {
    if (localStorage.Lang != null) this.$i18n.locale = localStorage.Lang;
  }

最佳实现是使用 <script type="ts" setup></script>

参考官方文档:https://vuejs.org/api/sfc-script-setup.html

也可参考:https://learnvue.co/tutorials/script-setup

支持取消所有平台

  • 1、不再默认绑定平台,所有平台均支持删除
  • 2、修复重新刷新删除的平台再次从默认平台加载的问题

标题支持数字编号

支持标题自带数字编号,发布的时候自动去掉

例如:在思源笔记里面标题是

130.自定义类加载器与JVM内置加载器交互详析

发布之后是

自定义类加载器与JVM内置加载器交互详析

目前发布到部分平台已经完成,但是未做全量测试。

发布内容过滤支持开关

支持设置是否移除挂件html
支持设置是否移除H1

目前暂时是默认移除的,考虑到可能会有不想移除的情况

feat:增强Vuepress支持,如果设置了Github参数,使用Github API实现自动发布,否则自行复制文本

推荐配合 vuepress-theme-vdoing 使用

注意事项
1、Github的rest api的文件名不能有空格
community/community#14278

子任务

  • 1、新增Github的rest api
  • 2、ts泛型实现Vuepress发布参数配置
  • 3、修复 octokit 在vite构建报错问题,替换 node-fetchisomorphic-fetch
  • https://stackoverflow.com/questions/73095592/octokit-js-not-working-with-vite-module-externalized-and-cannot-be-accessed-in/73095593#73095593
  • 4、新增配置验证
  • 5、耗时的按钮操作添加 loading
  • 6、如果设置了Github参数,使用Github API实现自动发布,否则自行复制文本
  • 7、支持选择自定义发布目录
  • 8、支持修改发布后的文件名
  • 9、Vuepress的slug添加hash避免文章重复的冲突问题
  • 10、支持简洁模式与详细模式
  • 11、新增api状态,确保api可用性
  • 12、配置开关自动生效
  • 13、默认目录开关
  • 14、页面初始化也附加内容
  • 15、支持文章取消发布

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.