【總結】RSS Hub使用經驗

• Editor: Veagau
• Time: 2019.10.28

目錄

• 一、RSS Hub的使用
• 二、RSS使用
  • 1. Windows
  • 2. MAC
  • 3. Android

一、RSS Hub的使用

力求簡單，能用圖形界面操作的就用圖形界面操作。

1. Fork RSS Hub倉庫到自己的GitHub賬號下

2. 將自己的RSS Hub倉庫中download或clone到本地

3. 進入到項目文件夾中，在本地部署RSSHub環境

   1. 安裝依賴。執行如下命令：

      npm install
      

      或

      yarn
      

      執行上述命令的前提時你已經在計算機上安裝了npm或yarn，具體安裝過程不贅述。

      注意：

      • 安裝后記得配置全局變量、然后重啟項目終端。
      • npm安裝速度緩慢，不太推薦。
      • 有些依賴只兼容python 2.x 。如果沒有Python 2.x ，在安裝過程中會拋出Error，但實測不影響使用

   2. 啟動RSS Hub開發環境。

      npm run dev
      

      或

      yarn dev
      

   3. 在瀏覽器上打開鏈接：localhost:1200，顯示RssHub界面即部署成功。

4. 添加腳本路由。修改RSSHub>lib路徑下的router.js文件，向其中添加路由信息

   此處可仿照已有路由進行修改，例如：

   //其中get函數的第一項是在瀏覽器上訪問的路徑，此路徑是位於RSS Hub服務器中的相對路徑，正式訪問時還需再前面加上：（遠程）https://rsshub.app 或（本地）localhost:1200。
   //:type?-值傳遞給路徑的參數信息，如鍵入https://rsshub.app/upc/main/notice，服務器端就可以通過腳本文件中的參數解析獲取到notice，進而可以進行下一步操作。
   //第二項是路由腳本文件的存放路徑，當在瀏覽器中鍵入https://rsshub.app/upc/main/notice時，它會自動去服務器中的指定路徑上尋找腳本文件，此處腳本文件是main.js，指定路徑時文件后綴省略。
   router.get('/upc/main/:type?', require('./routes/universities/upc/main'));
   

5. 編寫路由腳本文件。根據上面指定的路由腳本文件的路徑，創建文件夾和js文件

   注意：

   • 在編寫js文件時需要用到一些前端知識，比如網頁元素的獲取和處理，此處推薦菜鳥教程。
   • 腳本文件的框架結構在RSS Hub的文檔有說明，具體參考RSS Hub-參與我們。
   • 在編寫自己的腳本文件時可以參考其他大佬的已經寫好的腳本文件，打開里面解析的網頁，看一下他是怎么獲取並解析網頁信息的，然后仿造着用到自己想要解析的網頁上就可以了。避免重復造輪子，這樣能夠極大的節省開發時間。

6. 添加腳本的說明文檔。修改/doc/路徑下對應的markdown文檔，如/doc/university.md。

   注意：

   • 樣例可參考RSS Hub-參與我們。

   • 務必將<Route>標簽封閉，否則檢查不通過。

     簡單內容用<Route ******/>，復雜內容（帶參數表）用<Route *****>參數表</Route>。

   • 添加完畢后，進行代碼格式標准化，對其提示的警告和錯誤信息進行修改。

     npm run format
     

7. 測試。

   上述操作完成后可在本地測試指定網站的RSS是否生成成功。

   如訪問鏈接：localhost:1200\upc\main\notice，如果返回xml文件內容則表示生成成功。

   如提示路由為空，則需檢查上面的操作是否有問題。

8. pull request

   • Pull Request，簡稱pr，指請求倉庫原有者拉取本人倉庫分支，合並到master分支中。
   • 此處為了簡化操作、節省時間-懶，可采用如下方法：
     1. 在自己的github賬號上打開已經fork的RSS Hub倉庫
     2. 替換自己修改了的文件，上傳自己創建的文件夾和文件，其他的保持不變。
     3. 返回倉庫主頁，點擊文件列表上方的pull request按鈕。
     4. 指定base repository（目標倉庫）和head repository（源倉庫），即請求將源倉庫合並到目標倉庫中，一般保持默認即可。
     5. 點擊create pull request即可創建pr請求。
     6. 之后等待倉庫原有者審核代碼，如有問題，則修改后重復上述步驟。
     7. 沒有問題的話，倉庫原有者就會將你的分支合並到主分支中
     8. 之后就可以通過rsshub的服務器訪問自己創建的rss了。

二、RSS使用

生成RSS 訂閱源后，需要搭配RSS 閱讀器才能瀏覽自己心儀的網頁內容。

推薦以下閱讀器（待補充）：

1. Windows

• irreader

2. MAC

• Reeder

3. Android

• Rolly
• FeedMe