Research Pocket 🔖

一个可自托管的“稍后阅读”工具，可与 getpocket.com（以及其他即将推出）集成。在网页和终端上工作

在 GitHub Pages 上创建自己的静态网站 ResearchPocket/my-list 📚

工作原理

安装

• 通过 版本页面 获取您桌面上的最新版本二进制文件

• 使用 Cargo

  $ cargo install research
  

生成您的网站

这需要您已安装并可在您的 $PATH

$ research init # initializes the database
$ research pocket auth # authenticate with pocket
$ research fetch # fetches your articles
$ # add --download-tailwind if you don't have tailwindcss installed in your $PATH
$ research --db ./research.sqlite generate . # generate your site

Cli 帮助

• 基本帮助

  RESEARCH 🔖
  
  Manage your reading lists and generate a static site with your saved articles.
  
  Usage: research [OPTIONS] [COMMAND]
  
  Commands:
    pocket    Pocket related actions
    fetch     Gets all data from authenticated providers
    list      Lists all items in the database
    init      Initializes the database
    generate  Generate a static site
    help      Print this message or the help of the given subcommand(s)
  
  Options:
        --db <DB_URL>  Database url [env: DATABASE_URL=] [default: ./research.sqlite]
    -d, --debug...     Turn debugging information on
    -h, --help         Print help
    -V, --version      Print version
  

• 初始化

  Initializes the database
  
  Usage: research init <PATH>
  
  Arguments:
    <PATH>  
  
  Options:
    -h, --help  Print help
  

• Pocket

  Pocket related actions
  
  Usage: research pocket [COMMAND]
  
  Commands:
    auth   Authenticate using a consumer key
    fetch  Fetch items from pocket
    help   Print this message or the help of the given subcommand(s)
  
  Options:
    -h, --help  Print help
  

• 获取

  Gets all data from authenticated providers
  
  Usage: research fetch
  
  Options:
    -h, --help  Print help
  

• 生成

  以下是生成静态网站的示例

  $ research --db <path/to/research.sqlite> generate --assets <path/to/assets> <path/to/output>
  

  可选地添加 --download-tailwind 下载并重复使用资产目录中的 tailwindcss 二进制文件。

    Generate a static site
  
    Usage: research generate [OPTIONS] <OUTPUT>
  
    Arguments:
      <OUTPUT>  The path to the output directory
  
    Options:
          --assets <ASSETS>    Path to required site assets (main.css, search.js, tailwind.config.js) [default: ./assets]
          --download-tailwind  Download Tailwind binary to <ASSETS>/tailwindcss if not found
      -h, --help               Print help