{"id":22942485,"url":"https://github.com/stardustdl/paperead","last_synced_at":"2025-08-12T21:32:44.015Z","repository":{"id":37798747,"uuid":"410428893","full_name":"StardustDL/paperead","owner":"StardustDL","description":"A tiny tool to present and manage your reading and notes.","archived":false,"fork":false,"pushed_at":"2023-09-04T15:04:48.000Z","size":386,"stargazers_count":6,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-04-28T01:20:28.504Z","etag":null,"topics":["flask","markdown","notes","python","vue","vuejs"],"latest_commit_sha":null,"homepage":"https://paperead.netlify.app/","language":"Vue","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/StardustDL.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2021-09-26T02:24:19.000Z","updated_at":"2024-04-28T01:20:28.505Z","dependencies_parsed_at":"2024-11-17T03:00:39.418Z","dependency_job_id":null,"html_url":"https://github.com/StardustDL/paperead","commit_stats":{"total_commits":75,"total_committers":2,"mean_commits":37.5,"dds":"0.013333333333333308","last_synced_commit":"c66ae7c585235e1b529ee24a5320bc957e58c85c"},"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StardustDL%2Fpaperead","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StardustDL%2Fpaperead/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StardustDL%2Fpaperead/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StardustDL%2Fpaperead/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StardustDL","download_url":"https://codeload.github.com/StardustDL/paperead/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":229710743,"owners_count":18111641,"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":["flask","markdown","notes","python","vue","vuejs"],"created_at":"2024-12-14T13:47:56.860Z","updated_at":"2024-12-14T13:47:57.593Z","avatar_url":"https://github.com/StardustDL.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Paperead](https://socialify.git.ci/StardustDL/paperead/image?description=1\u0026font=Bitter\u0026forks=1\u0026issues=1\u0026language=1\u0026owner=1\u0026pattern=Plus\u0026pulls=1\u0026stargazers=1\u0026theme=Light)](https://github.com/StardustDL/paperead)\n\n![](https://github.com/StardustDL/paperead/workflows/CI/badge.svg) [![Netlify Status](https://api.netlify.com/api/v1/badges/fb053a29-d62b-469d-9253-d8208fec5863/deploy-status)](https://app.netlify.com/sites/paperead/deploys) ![](https://img.shields.io/github/license/StardustDL/paperead.svg) [![](https://img.shields.io/pypi/v/paperead.svg?logo=pypi)](https://pypi.org/project/paperead/) [![Downloads](https://pepy.tech/badge/paperead)](https://pepy.tech/project/paperead)\n\n[Paperead](https://github.com/StardustDL/paperead) is a tiny tool to present and manage your reading and notes.\n\n- Platform ![](https://img.shields.io/badge/Linux-yes-success?logo=linux) ![](https://img.shields.io/badge/Windows-yes-success?logo=windows) ![](https://img.shields.io/badge/MacOS-yes-success?logo=apple) ![](https://img.shields.io/badge/BSD-yes-success?logo=freebsd)\n- Python ![](https://img.shields.io/pypi/implementation/paperead.svg?logo=pypi) ![](https://img.shields.io/pypi/pyversions/paperead.svg?logo=pypi) ![](https://img.shields.io/pypi/wheel/paperead.svg?logo=pypi)\n\n## Features\n\n- File-system based storage\n  - Simple and readable\n  - Easy to use with VSCode\n- Notes in markdown\n  - CommonMark\n  - LaTex Math\n  - Media (locally hosted or remote files)\n  - Code highlighting\n  - Lists and tables\n  - Graphs\n- Rich pages\n  - Slides powered by reveal.js\n  - Image, audio, and video.\n  - PDF and links.\n  - Dynamic generated (use Python script).\n  - Raw HTML.\n- Builtin web server\n  - Basic authentication\n  - Readonly mode\n  - RESTful API\n- Frontend in browser\n  - Dynamic markdown rendering\n  - Builtin reader mode\n- Static website generator\n\nFor details about features, installation and usage, visit [documents](https://paperead.netlify.app/) website powered by Paperead.\n\n## Install\n\nUse pip:\n\n```sh\npip install paperead\n```\n\n## Usage\n\n```sh\npaperead new first-material\npaperead new first-material -N first-note\n\npaperead serve\n\n# Visit http://localhost:3649\n```\n\n## Development\n\n```sh\n# Run backend\n\ncd src/main\npip install -r requirements.txt\npython -m paperead -D \"path/to/dataDir\" serve\n# endpoint: http://localhost:3649/api\n\n# Run frontend\ncd src/web\nnpm install\nnpm run restore\nnpm run dev\n# endpoint: http://localhost:3600\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstardustdl%2Fpaperead","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstardustdl%2Fpaperead","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstardustdl%2Fpaperead/lists"}