pervane

佩尔万 |演示 |安装并运行 |维基 |讨论

Pervane 是一个基于纯文本文件的笔记和知识库构建工具。它兼作简单的文件服务器，在 Web 浏览器中呈现给定的目录文件，同时它也可以用作云 IDE，具有出色的代码突出显示功能。它就像 python 内置的 SimpleHTTPServer，但功能更丰富一点，比如所见即所得的笔记体验、具有无限数量嵌套的侧边栏、超快的文本搜索、文件移动、从浏览器创建等。

主要用例是结合示例源文件创建、编辑、提供和搜索 Markdown 注释。

如果您使用基于纯文本的笔记，这对于临时媒体（例如没有 ChromeOS 等大型桌面应用生态系统或 Android 和 iOS 等移动操作系统的操作系统）很有帮助。

特征

• 完全私有，你的文件，你的电脑，没有数据库，没有安装（除了一些通用的Python包）。没有通过任何媒介收集统计数据。 （我只检查 pypi 统计数据）
• 自托管（正在开发托管版本，如果有人感兴趣，请留言！）
• 注释存储为纯文本文件，名称由您指定。 Pervane 不会自动重命名。
• 极快的用户界面和快速笔记切换。
• 选项卡式用户界面。
• 没有添加元数据文件等。只需全局文件、缓存 N 秒并创建文件树。
• 事实来源是您自己的文件系统，因此您可以使用您最喜欢的 Markdown 编辑器来修改您的笔记：QOwnNotes、VSCode、Sublime Text 等。
• 忽略某些文件以免显示在侧边栏上。
• 基于 Flask 的服务器，完全可破解，只需修改，它就是你的了。
• 最小依赖性，单个二进制文件。
• 使用银色搜索器 (ag) 即时搜索整个文件夹。
• 感谢 ag，无需为搜索做任何索引或准备工作。您只需使用一行命令即可开始使用 Pervane。
• 具有适当无限数量嵌套的文件树，非常适合分层笔记和知识库构建。
• 基于 Cookie 的身份验证。
• 没有统计数据收集，全部私有。
• 感谢 editor.md 提供丰富的文本编辑体验。
• 拼写检查器
• 在编辑器中查找替换。
• 隐藏/显示预览
• 使用 F11 或工具栏的全屏编辑模式
• 隐藏/显示工具栏
• 感谢 editor.md 有很多主题
• 使用拖放功能在目录之间移动文件。
• 键盘快捷键
• 快速模糊文件名搜索
• 直接编辑代码注释
• 将文件拖放到页面任意位置即可上传
• 图像/视频渲染（如果它们位于目录中）。
• 带有面包屑路径的目录浏览器。
• TeX/KaTeX、表情符号、任务列表支持。
• 所见即所得编辑器
• 可切换的侧边栏。
• 默认情况下，深色模式具有许多主题，例如 monokai、solarized 等。
• 带有同步滚动的并排降价预览。
• 全屏禅宗模式用于写作。
• 自动保存。

截图

所有屏幕截图和更多视频都位于 Pervane Wiki 中。

通过 pip 安装

screen
pip install pervane

# First make sure you create the admin user
pervane --mode=init

# Then run the app for reals.
# You can login with your recently created credentials.
pervane --dir=example/

当您访问 localhost:5000 时，Pervane 仅接受 1 个用户。因此，您的笔记只能由该单个用户看到。

️如果您看到服务器错误，请删除您的 cookie 并重试。

如果您是从 0.0.9 之前的版本升级

您可能会看到有关用户不存在的错误。您需要先运行pervane --mode=init 。我再次更改了用户身份验证模式（必须这样做，因为 Flask-user 已被弃用）。对此感到抱歉。

软件包详细信息在这里：https://pypi.org/project/pervane/

您还可以使用 Docker 运行 Pervane 或从源代码构建它。请访问 Pervane Wiki 了解更多安装选项。

贡献

请并谢谢你:)

 # Init:
git clone https://github.com/hakanu/pervane.git && cd pervane

# Set up local env.
virtualenv -p python3 env
source env/bin/activate
pip install -r requirements.txt

# Run
python3 pervane/serve.py --debug=true