35 Star 150 Fork 32

xupingmao / xnote

Create your Gitee Account
Explore and code with more than 6 million developers,Free private repositories !:)
Sign up
Clone or download
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md

Xnote

Build Status Coverage Status

xnote是一款面向个人的轻量级笔记系统,提供多种维度的数据管理功能。它主要有如下特性

  • 拥有丰富的数据管理能力,支持多种笔记格式以及文件管理功能
  • 自带工具箱,默认提供了大量常用的工具
  • 提供扩展能力,用户可以编写各种插件满足自己的需求
  • 跨平台,支持Windows、Mac、Linux三大平台,可以在云服务上部署,也可以在本地运行
  • 多用户支持

以下是一些页面展示

笔记


项目地址

安装运行

  • 安装python(建议Python3,Python2.7版本不再维护)
  • 安装依赖的软件包
    • Mac/Linux执行 python -m pip install -r requirements.txt
    • Windows执行 python -m pip install -r requirements.win.txt
  • 启动服务器python app.py, 默认1234端口, 浏览器打开http://localhost:1234/ 无需额外配置,初始化的管理员账号是admin/123456
  • 可以直接部署在新浪云应用SAE上面
  • 如果安装老版本后更新启动失败参考 数据库迁移

启动参数

  • --data {data_path} 指定数据存储的data目录,比如python app.py --data D:/data
  • --port 1234启动端口号,注意优先使用环境变量{PORT}设置的端口号,这是为了自适应云服务容器的端口
  • --useUrlencode yes针对只支持ASCII编码的文件系统开启urlencode转换非ASCII码字符
  • --minthreads {number} web请求处理线程数

主要功能

笔记管理

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

文件管理

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

工具箱

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

系统扩展

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

具体特性如下

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

相关文档

协议

  • GPL

Comments ( 20 )

Sign in for post a comment

About

可扩展的知识库 spread retract
Python and 6 more languages
GPL-3.0
Cancel

Releases

No release

xnote

Contributors

All

Activities

load more
can not load any more
Python
1
https://gitee.com/xupingmao/xnote.git
git@gitee.com:xupingmao/xnote.git
xupingmao
xnote
xnote
master

Search