# polar-bookshelf

**Repository Path**: FreeCode/polar-bookshelf

## Basic Information

- **Project Name**: polar-bookshelf
- **Description**: 适用于Mac，Windows和Linux的强大文档管理器，用于管理Web内容，书籍和笔记 - 支持标记，注释，突出显示和跟踪您的阅读进度
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 7
- **Created**: 2021-06-14
- **Last Updated**: 2021-06-14

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p align="center">
    <img src="https://github.com/burtonator/polar-bookshelf/blob/master/icon.png" width="256">
</p>

<div align="center">
  <h1>Polar Bookshelf</h1>

<a href="https://github.com/burtonator/polar-bookshelf/releases">
     <img src="https://img.shields.io/github/downloads/burtonator/polar-bookshelf/total.svg"/>
</a>

<a href="https://discord.gg/GT8MhA6">
    <img src="https://img.shields.io/discord/477560964334747668.svg?logo=discord"/>
</a>

<a href="https://github.com/burtonator/polar-bookshelf">
    <img src="https://img.shields.io/github/stars/burtonator/polar-bookshelf.svg?style=social&label=Star"/>
</a>

<a href="https://twitter.com/getpolarized?ref_src=twsrc%5Etfw">
    <img src="https://img.shields.io/twitter/follow/getpolarized.svg?style=social&label=Follow"/>
</a>

<a href="#backers" alt="sponsors on Open Collective">
<img src="https://opencollective.com/polar-bookshelf/backers/badge.svg" />
</a> 
<a href="#sponsors" alt="Sponsors on Open Collective">
<img src="https://opencollective.com/polar-bookshelf/sponsors/badge.svg" />
</a>

<br/>
<br/>

Polar is personal knowledge repository which supports advanced
features like incremental reading, annotation, comments, and spaced repetition. 
It supports reading PDF, EPUB, and the web content.
</div>

# Features

- **PDF support** We have first-class PDF support thanks to <a href="https://mozilla.github.io/pdf.js/">PDF.js</a>.  PDFs work well when reading content in book format or when reading scientific
research which is often stored as PDF.

- **EPUB support** Add any EPUB and we also capture web content to EPUB/

- **Captured Web Pages** Download HTML content and save them as offline documents which can be annotated.

- **Pagemarks** Easily keep track of what you're reading and the progress of each document.

- **Text Highlights** Highlight text in PDF and web pages.

- **Area Highlights** Capture a region of the page as a highlight which can be a chart, figure, infographic, etc.  

- **Portable** Run across any platform. ```Linux```, ```MacOS```, and ```Windows``` supported. 

# [Downloads](https://getpolarized.io/download)

Packages for Windows, MacOS, and Linux are available on the [downloads](https://getpolarized.io/download) page.

We also have a [CHANGELOG](./docs/CHANGELOG.md) available if you're interested into what went into each release.

# Discussion

We have both a [Discord](https://discord.gg/GT8MhA6) group and
[Reddit](https://www.reddit.com/r/PolarBookshelf/) group if you want to discuss
Polar.

If it's a very technical issue it might be best to [create a Github Issue](https://github.com/burtonator/polar-bookshelf/issues/new). 

## Contributors

This project exists thanks to all the people who contribute. <img src="https://opencollective.com/polar-bookshelf/contributors.svg?width=890&button=false" />

## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/polar-bookshelf#sponsor)]

<a href="https://opencollective.com/polar-bookshelf/sponsor/0/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/0/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/1/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/1/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/2/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/2/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/3/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/3/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/4/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/4/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/5/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/5/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/6/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/6/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/7/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/7/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/8/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/8/avatar.svg"></a>
<a href="https://opencollective.com/polar-bookshelf/sponsor/9/website" target="_blank"><img src="https://opencollective.com/polar-bookshelf/sponsor/9/avatar.svg"></a>

# License

Polar is distributed under the GPLv3.  

[PDF.js](https://github.com/mozilla/pdf.js) is available under the Apache License.
[Electron](https://github.com/electron/electron) is released under the MIT License.
Rest of the code is MIT-licensed.