{"id":13456856,"url":"https://github.com/xupingmao/xnote","last_synced_at":"2025-03-24T11:31:46.644Z","repository":{"id":23755556,"uuid":"75524080","full_name":"xupingmao/xnote","owner":"xupingmao","description":"个人知识库+工具箱","archived":false,"fork":false,"pushed_at":"2024-10-20T15:50:23.000Z","size":16871,"stargazers_count":134,"open_issues_count":2,"forks_count":51,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-10-20T18:14:14.984Z","etag":null,"topics":["cms","pim","python","webpy"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/xupingmao.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-12-04T07:40:34.000Z","updated_at":"2024-10-06T04:34:15.000Z","dependencies_parsed_at":"2023-02-18T15:30:38.247Z","dependency_job_id":"a9986214-96bf-4ce3-ba31-0bc2f76a4bd8","html_url":"https://github.com/xupingmao/xnote","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xupingmao%2Fxnote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xupingmao%2Fxnote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xupingmao%2Fxnote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/xupingmao%2Fxnote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/xupingmao","download_url":"https://codeload.github.com/xupingmao/xnote/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221962483,"owners_count":16908339,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cms","pim","python","webpy"],"created_at":"2024-07-31T08:01:29.010Z","updated_at":"2025-03-24T11:31:46.636Z","avatar_url":"https://github.com/xupingmao.png","language":"Python","funding_links":[],"categories":["Python","置顶"],"sub_categories":["1、AI应用生态"],"readme":"# Xnote\n\n[![Coverage Status](https://coveralls.io/repos/github/xupingmao/xnote/badge.svg?branch=master)](https://coveralls.io/github/xupingmao/xnote?branch=master)\n![Docker Image](https://img.shields.io/docker/pulls/donjuanplatinum/xnote)\n\nxnote是一款面向个人的轻量级笔记系统，提供多种维度的数据管理功能，致力于把个人从信息过载中解放出来。它主要有如下特性\n\n- 拥有丰富的数据管理能力，支持多种笔记格式以及文件管理功能\n- 默认提供了一些常用的工具，同时提供扩展能力，用户可以编写各种插件满足自己的需求\n- 跨平台，支持Windows、Mac、Linux三大平台，可以在云服务上部署，也可以在本地运行\n- 100%自由的数据控制权，可以运行在多种数据库环境中\n- 支持小规模的多用户，面向多用户的商业场景使用请谨慎\n\n目前xnote定位是一个面向个人使用的小型笔记产品，不会重点投入以下方向\n- 大规模的多用户支持\n- 多用户协作功能\n\n如果你热爱技术爱折腾、需要多元的数据处理能力、希望完全掌控自己的文档数据，本产品将会是一个不错的尝试，欢迎试用反馈。\n\n- 体验demo网址 https://1k5u680558.goho.co/\n- 测试账号 user01/123456, user02/123456 友情提示：管理员会不定期清理数据，请勿存放重要数据\n\n以下是一些页面展示\n\n功能列表\n![功能列表](https://cdn.jsdelivr.net/gh/xupingmao/xnote-doc/images/v2.9.6/app_index.png)\n\n笔记本\n![笔记](https://cdn.jsdelivr.net/gh/xupingmao/xnote-doc/images/v2.9.7/books.png)\n\nmarkdown页面\n![markdown](https://cdn.jsdelivr.net/gh/xupingmao/xnote-doc/images/v2.9.6/markdown.png)\n\n-----\n## 项目地址\n\n- [github](https://github.com/xupingmao/xnote)\n- [gitee](https://gitee.com/xupingmao/xnote)\n\n如果使用过程中遇到问题，欢迎在项目主页提issue或者评论。\n\n## 安装\u0026运行\n\n### 物理机安装\n\n#### 安装依赖环境\n\n- Python \u003e= 3.6\n- 安装依赖的软件包\n    - 最小化安装(使用sqlite) `python3 -m pip install -r config/requirements.min.txt`\n    - Mac/Linux执行 ```python -m pip install -r config/requirements.txt```\n    - Windows执行 `python -m pip install -r config/requirements.win.txt`\n\n#### 配置和启动\n\n默认的配置文件位于`config/boot/boot.default.properties`，具体的功能参考配置的注释\n\n```sh\n# 切换到xnote目录\n\u003e cd xnote\n# 复制配置并且进行自定义配置\n\u003e cp config/boot/boot.min.properties boot.local.properties\n# 启动\n\u003e python3 app.py --config boot.local.properties\n```\n\n如果不修改端口号，启动之后在浏览器打开 http://localhost:1234/ 就可以使用了，初始化的管理员账号是admin，默认密码是 123456\n\n### Docker-compose\n\n1. 创建持久化数据目录 ```mkdir data```\n2. 创建配置文件 `cp ./config/boot/boot.default.properties ./boot.local.properties`\n3. 根据自己的需求修改 `boot.local.properties`\n4. 执行命令 ```docker-compose up -d```\n\n### 在云服务平台部署\n\n- 新浪SAE TODO\n- [CentOS - 百度BAE](https://blog.csdn.net/u011320646/article/details/126334377) \n\n## 主要功能\n\n### 笔记管理\n- 支持多种格式：markdown/表格/相册/列表\n- 组织功能：通过笔记本/标签/优先级来管理文档\n- 分享功能：在笔记的详情页面，点击【更多】下拉列表里面的分享，可以将文章分享给未登录用户查看\n- 优先级管理：置顶、归档功能\n- 备份功能：笔记的修改历史\n- 搜索功能：支持整个知识库搜索和项目内搜索\n- 评论功能：支持登录用户的评论\n- 访问统计：最近、常用的访问统计\n- 其他文档工具\n\n### 文件管理\n- 多种视图：列表、网格\n- 文件操作：文件上传、下载、新建、删除、重命名、移动等操作\n- 文件工具：代码编辑器、文本阅读器、二进制查看器、文件内容搜索等等\n- 大文件支持：文件下载支持断点续传，支持超大文件上传（测试过1G文件）\n- 扩展：支持开发插件扩展\n\n### 工具箱\n- Python文档(pydoc)\n- 文本处理(文本对比、代码生成、密码生成)\n- 编解码工具(base64、md5、进制转换、等等)\n- 条形码、二维码生成器\n- 图像处理（合并、拆分、灰度转换）\n- 提供扩展能力，开发者可以自己开发插件\n\n## 系统扩展\n\n### 插件机制\n\n由于每个人的需求不同，单一系统很难满足，开发者可以根据自己需要编写插件来扩展系统的功能。具体可以参考文档 [插件扩展](./docs/plugins.md)。\n\n具体特性如下\n\n- 插件中可以监听系统消息，包括笔记、提醒、文件、时间、系统五种类型的消息\n- 插件可以通过`category`属性设置分类，显示在笔记、文件、系统等功能的选项入口中\n- 可以通过模板创建插件\n\n### 二次开发\n\n- xnote现在已经打包上传到pypi[xnote-web](https://pypi.org/project/xnote-web/), 这样可以通过模块化的方式进行二次开发\n\n\n## 相关文档\n- [更新日志](./docs/changelog.md)\n- [系统架构](./docs/architecture.md)\n- [编码规范](./docs/code_style.md)\n- [插件扩展](./docs/plugins.md)\n- [搜索扩展](./docs/search_extension.md)\n- [数据库迁移](./docs/db_migrate.md)\n\n## 协议\n\n- GPL\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxupingmao%2Fxnote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fxupingmao%2Fxnote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fxupingmao%2Fxnote/lists"}