README.md

sy-post-publisher

将 思源笔记 的文章发布到支持的平台的 思源笔记挂件

使用之前请务必详细阅读 快速上手指南

项目运行状态

v0.7.0 特性一览^new

PicGO 相关

• 新增用户友好的 PicGO 图形化配置界面
• 优化 PicGO 配置，支持 PicGO 插件

系统配置相关

• 整合系统所有配置项，提供统一的配置入口

发布体验相关

快速上手指南

FAQ

Q1：使用此思源笔记挂件或者浏览器插件有什么注意事项吗？

A1：有。 特别提示：【自定义 JS 片段】请不要和【挂件通用版】混合使用，使用其中一种即可。避免因为混用导致配置同步问题。 浏览器插件无限制。

Q2：有哪些方式可以使用？具体步骤是什么？

A2：请参考下面三种模式及其详细说明。特别注意温馨提示的内容。

模式一：挂件版挂载菜单打开新窗口操作方式快速上手 ^{强烈推荐 0.4.2+}

首先在设置 - 集市 - 挂件 中下载 sy-post-publisher

点击设置 - 外观- 代码片段，代码片段加上下面的 js 片段，然后重启思源

// 如果不喜欢这个菜单，直接去掉这个代码片段引用即可，去掉之后仍然可以通过挂件版通用方式使用
import("/widgets/sy-post-publisher/lib/siyuanhook.js")

点击按钮开始体验。

详情请参考: 挂件模式用挂载菜单的方式使用

温馨提示：此模式下，功能已经是最全面的了，直接使用菜单功能即可，请不要再添加挂件。避免因为混用导致配置同步问题。

模式二：挂件版通用方式快速上手

首先在设置 - 集市 - 挂件 中下载 sy-post-publisher

然后写好文章

在文中最后面输入 / 找到挂件，选择 sy-post-publisher

然后选择你需要的平台然后进行设置

点击发布即可。

温馨提示：不建议通用版模式下添加 JS 片段，可能会导致配置不同步问题。要么单独使用通用版，要么单独使用挂载菜单。

模式三：浏览器插件快速上手

参考 浏览器插件快速上手指南

Q3: siyuanhook.js 新增挂载了哪些对象？在哪些场景挂载？目的是什么？

A3：SyPicgo、syp、terwer（仅新窗口）、SyCmd。仅在 Electron 环境（即思源笔记内部挂载）。浏览器插件和自部署模式无此功能。目的是为了扩展思源笔记的功能。

支持平台

• Hugo ^推荐
• Docsy ^推荐
• Hexo
• Jekyll（Github pages 默认内置支持的平台）
• Vuepress
• Vitepress
• Nuxt
• Next
• 博客园 ^推荐
• CSDN ^预研
• 知乎 ^预研
• 语雀 ^推荐
• 开源中国
• 链滴社区
• WordPress
• Confluence ^{通过接口适配器支持}
• Metaweblog API
• 自定义 HTTP 协议 ^预研

更多内容请查看

技术方案

开发进度

更新日志

🎈 鸣谢

sy-post-publisher 项目的诞生与成长离不开下列开源项目的贡献，以及热心网友的反馈和建议。

思源社区

思源笔记

思源笔记非官方 QQ 群

欢迎加入 思源爱好者折腾群 : 1017854502 ， 群内有各种爱折腾的技术大佬、萌妹子、热心网友，绝对不容错过。。。

资源

UI 框架：（排名不分先后）

• Vue3
• Element-Plus
• lute
• FontAwesome

技术框架或托管平台：（排名不分先后）

• xmlrpc
• yaml
• vercel

个人

技术支持：（排名不分先后）

• 感谢 Soltus 提供的新窗口打开相关代码及实现思路

• 感谢 leolee9086 提供的挂载菜单相关代码及实现思路

• 感谢 Zuoqiu-Yingyi 开源的 Dark+ 主题的灵感

• 感谢 svchord 开源的 Rem Craft 主题的灵感

版权声明

本作品以 GPL V3 形式开源

/*
 * Copyright (c) 2022, Terwer . All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Terwer designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Terwer in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Terwer, Shenzhen, Guangdong, China, youweics@163.com
 * or visit www.terwer.space if you need additional information or have any
 * questions.
 */