Skip to content

Latest commit

 

History

History
85 lines (61 loc) · 3.59 KB

README_zh_CN.md

File metadata and controls

85 lines (61 loc) · 3.59 KB

English

在线分享

icon

您梦寐以求的类 notion 分享功能,这里也有。

基于思源笔记的本地化理念,本插件原生支持本地局域网分享、并且可通过 docker 版插件支持远程分享。无需任何额外的服务端支持,有思源笔记即可。

本插件的核心理念是:一切皆页面 。您可以设置某个页面为主页。

重要提示:

  1. 1.8.0+ 版本对公共分享和授权码模式下的分享逻辑进行了统一处理,因此需要初始化分享类型,避免旧的分享链接访问异常,您只需要打开一次分享弹窗即可,打开之后会自动初始化。
  2. 1.8.0+ 授权码模式下的分享也能支持图片显示啦,快去试试吧😄

帮助文档

核心特色

  • 一键分享:支持一键分享文档到局域网,如果需要远程分享,可使用 docker 部署在服务器,然后安装插件
  • 权限控制:只能查看已分享的页面,未分享的页面无权限查看
  • 过期时间:支持设置过期时间,过期时间之后将无法查看
  • 个人主页:支持设置已分享的某个页面为主页,可作为自定义博客主页
  • 主题集成:默认集成 默认主题 和 Zhihu 主题,后续可支持切换其他主题
  • SEO优化:支持自动生成标题、摘要、首图,便于SEO
  • 多种部署:支持思源笔记插件、docker自部署、Vercel托管满足各种人群的需求,详情请看 docs
    • [入门级]思源笔记插件:零配置,开箱即用,本地SPA应用,直接访问思源本体,因此速度极快,但是SEO不太友好
    • [高手级]docker自部署:需要自己购买服务器,SSR服务端渲染,SEO友好,速度快
    • [白嫖级]Vercel托管:需要自己购买域名,否则可能无法访问,成本低,速度适中
  • 分享模式:默认支持公共笔记分享,开启授权码之后可支持有限的分享功能。

TODO

  • 支持替换图片链接
  • 支持自定义域名
  • 支持内部链接和外部链接
  • 支持任务列表
  • 支持开启授权码下的分享
  • 无序列表样式适配
  • 已分享页面的批量管理
  • 支持单页面设置分享密码
  • 集成目前已有的热门主题
  • 支持文档别名访问
  • 支持显示 MD 原文
  • 支持显示 KMD 原文
  • 子文档文档树
  • 页面大纲
  • 标签、摘要
  • 自定义属性
  • 图片放大效果
  • Latex 公式渲染
  • plantuml 图表支持
  • echats 图表支持
  • 支持思源自带的svg,例如 <use xlink:href="#iconMore"></use>

更新历史

请参考 CHANGELOG

开发

请参考 DEVELOPMENT

捐赠

如果您认可这个项目,请我喝一杯咖啡吧,这将鼓励我持续更新,并创作出更多好用的工具~

微信

wechat

支付宝

alipay

感谢

感谢来自开源社区提供的解决方案,简化了本项目的不少工作!