A tiny tool to present and manage your reading and notes.
Project description
Paperead is a tiny tool to present and manage your reading and notes.
- Platform
- Python
Features
- File-system based storage
- Simple and readable
- Easy to use with VSCode
- Notes in markdown
- CommonMark
- LaTex Math
- Media (locally hosted or remote files)
- Code highlighting
- Lists and tables
- Graphs
- Rich pages
- Slides powered by reveal.js
- Image, audio, and video.
- PDF and links.
- Dynamic generated (use Python script).
- Raw HTML.
- Builtin web server
- Basic authentication
- Readonly mode
- RESTful API
- Frontend in browser
- Dynamic markdown rendering
- Builtin reader mode
- Static website generator
For details about features, installation and usage, visit documents website powered by Paperead.
Install
Use pip:
pip install paperead
Usage
paperead new first-material
paperead new first-material -N first-note
paperead serve
# Visit http://localhost:3649
Development
# Run backend
cd src/main
pip install -r requirements.txt
python -m paperead -D "path/to/dataDir" serve
# endpoint: http://localhost:3649/api
# Run frontend
cd src/web
npm install
npm run restore
npm run dev
# endpoint: http://localhost:3600
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
paperead-0.2.6.tar.gz
(787.2 kB
view hashes)
Built Distribution
paperead-0.2.6-py3-none-any.whl
(798.6 kB
view hashes)