Pap

简介

Pap 是一个 markdown 笔记软件，通过标签对笔记进行管理，自动生成引用关系网络.

安装

Pap 需要 Python 3.11.4 的运行环境. 所有脚本均可通过 Get-Help script.ps1 (Windows) 或者 script.sh --help (Linux) 获取帮助信息

Windows/Linux

从 release 中下载最新版本的压缩包 PapPack，解压后在 PapPack 目录下运行 .\pap.ps1 (Windows) 或者 ./pap/sh (Linux) 即可启动程序，用浏览器打开对应的网络地址即可查看.

Docker

运行 docker build -t pap . 即可构建 docker 镜像，容器内默认服务地址为 172.17.0.2:13956，容器暴露端口为 13956

从源码构建

从源码构建 Pap 需要安装 Node.js v18.17.0 和 Python 3.11.4 运行时，在项目目录下运行 .\scripts\tools.ps1 -Pack (Windows) 或者 ./scripts/tool.sh --pack (Linux) 即可

开发

scripts\tool.ps1 和 scripts/tool.sh 提供了一些实用开发工具，如静态类型检查，测试，编译构建和打包。通过 Get-Help .\scripts\tools.ps1 或者 ./scripts/tool.sh --help 命令获取脚本的更多帮助信息.

TODO

• Markdown Parser
• Markdown Editor
• File Lock
• Not save tip
• File Rename
• Note Tag
• Rightbar
• Private Lock
• Keymap
• Title List
• Markdown Ref net
• Resource
• Pdf viewer
• Data Export
• Grep
• Resource folder
• Note folder
• ctrl-z
• code mode