39 Star 170 Fork 36

xupingmao / xnote

加入 Gitee
与超过 800 万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README.md

Xnote

Build Status Coverage Status

xnote是一款面向个人的轻量级笔记系统,提供多种维度的数据管理功能,致力于把个人从信息过载中解放出来。它主要有如下特性

  • 拥有丰富的数据管理能力,支持多种笔记格式以及文件管理功能
  • 默认提供了一些常用的工具,同时提供扩展能力,用户可以编写各种插件满足自己的需求
  • 跨平台,支持Windows、Mac、Linux三大平台,可以在云服务上部署,也可以在本地运行
  • 100%自由的数据控制权,可以运行在多种数据库环境中
  • 支持小规模的多用户,面向多用户的商业场景使用请谨慎

目前xnote定位是一个面向个人的开源产品,不会重点投入以下方向

  • 大规模的多用户支持
  • 多用户协作功能

如果你热爱技术爱折腾、需要多元的数据处理能力、希望完全掌控自己的文档数据,本产品将会是一个不错的尝试,欢迎试用反馈。

以下是一些页面展示

笔记


项目地址

如果使用过程中遇到问题,欢迎在项目主页提issue或者评论。

安装&运行

安装依赖环境

  • 安装python(建议Python3,Python2.7版本不再维护)
  • 安装依赖的软件包
    • Mac/Linux执行 python -m pip install -r config/requirements.txt
    • Windows执行 python -m pip install -r config/requirements.win.txt

配置和启动

默认的配置文件位于config/boot/boot.default.properties,具体的功能参考配置的注释

# 指定自定义的配置文件
python3 app.py --config config/boot/自定义名称.properties

如果不修改端口号,启动之后在浏览器打开 http://localhost:1234/ 就可以使用了,初始化的管理员账号是admin,默认密码是 123456

在云服务平台部署

  • 新浪SAE TODO
  • 百度BAE TODO

兼容性问题

如果安装老版本后更新启动失败参考 数据库迁移 或者查看Issue,如果问题还没解决可以提交新的Issue

主要功能

笔记管理

  • 支持多种格式:markdown/富文本/表格/相册/列表
  • 组织功能:通过项目来管理文档
  • 分享功能:在笔记的详情页面,点击【更多】下拉列表里面的分享,可以将文章分享给未登录用户查看
  • 优先级管理:置顶、归档功能
  • 备份功能:笔记的修改历史
  • 搜索功能:支持整个知识库搜索和项目内搜索
  • 评论功能
  • 访问统计:最近、常用的访问统计
  • 其他文档工具

文件管理

  • 多种视图:列表、网格
  • 文件操作:文件上传、下载、新建、删除、重命名、移动等操作
  • 文件工具:代码编辑器、文本阅读器、二进制查看器、文件内容搜索等等
  • 大文件支持:文件下载支持断点续传,支持超大文件上传(测试过1G文件)
  • 扩展:支持开发插件扩展

工具箱

  • Python文档(pydoc)
  • 文本处理(文本对比、代码生成、密码生成)
  • 编解码工具(base64、md5、进制转换、等等)
  • 条形码、二维码生成器
  • 图像处理(合并、拆分、灰度转换)
  • 提供扩展能力,开发者可以自己开发插件

系统扩展

由于每个人的需求不同,单一系统很难满足,开发者可以根据自己需要编写插件来扩展系统的功能。具体可以参考文档 插件扩展

具体特性如下

  • 插件中可以监听系统消息,包括笔记、提醒、文件、时间、系统五种类型的消息
  • 插件可以通过category属性设置分类,显示在笔记、文件、系统等功能的选项入口中
  • 可以通过模板创建插件

相关文档

协议

  • GPL

仓库评论 ( 26 )

你可以在登录后,发表评论

简介

可扩展的知识库 展开 收起
GPL-3.0
取消

发行版

暂无发行版

xnote

贡献者

全部

近期动态

加载更多
不能加载更多了
Python
1
https://gitee.com/xupingmao/xnote.git
git@gitee.com:xupingmao/xnote.git
xupingmao
xnote
xnote
master

搜索帮助

101014 b92fc32e 1850385 101014 af024cb7 1850385