當前位置: 妍妍網 > 碼農

2.3K star!自己搭建一個 Web 線上筆記庫,真香!

2024-01-27碼農

* 戳上方藍字「 開源先鋒 」關註我

推薦閱讀:


大家好,我是開源君!

到年底了,各種總結、報告又要開始準備起來了,看著硬碟裏那一大堆的資料,真是頭大!

不過還好,我發現了一個好用的 Web 筆記套用 - BatNoter ,支持 markdown 語法,可托管同步到 Github,安全方便,非常適合咱們程式設計師使用。

簡介

BatNoter ,一個自托管的 Web 端的筆記程式,主要使用 react(typescript)、redux-toolkit 和 mui 元件構建的前端計畫。

支持將 GitHub 倉庫作為個人筆記儲存庫(這個好評),同時支持筆記分類、搜尋、Markdown 快捷編輯與預覽、書簽管理等內容。

目前 BatNoter 在 github 上收獲了 2.3K star。

如果你還擔心雲筆記的內容不安全,或者還在為雲筆記的托管費用而不開心的話,那麽一定要試試這個計畫,筆記內容都是雲托管在自己的 Git 倉庫,非常的香!!!

計畫特點

  • 使用 GitHub 登入。

  • 使用漂亮幹凈的使用者介面輕松建立、編輯、刪除、組織和探索筆記。

  • 支持 Markdown 格式,允許使用者在筆記中添加超連結、表格、標題、程式碼塊、塊參照等。

  • 編輯器允許預覽。

  • 使用復制到剪貼簿按鈕從程式碼部份快速復制程式碼。

  • 將筆記直接儲存在根目錄或使用資料夾來組織它們(支持巢狀)。

  • 透過單擊瀏覽特定目錄中的所有筆記。

  • 所有筆記都儲存在使用者的 GitHub 儲存庫中。

  • 緩存筆記以避免額外的 API 呼叫。

  • URL 可以加書簽。

  • 支持暗/亮模式。

  • 效果預覽

    直接開啟官網進行體驗:

    https://batnoter.com/

    使用 Github 帳號就可以登入。

    新建筆記

    設定筆記倉庫

    預覽筆記

    檢視筆記內容

    亮/暗模式切換

    本地開發環境搭建

    本地需要搭建 Node 環境,並且註意,Node.js 版本18或以上。

    啟動服務

    npm install
    npm start

    然後在瀏覽器輸入 http://localhost:3000 檢視執行的效果。

    執行測試

    npm test

    另外,官方還貼心的準備了一些 FAQ,方便新人操作。

    更多其他的使用功能、細節,感興趣的小夥伴可以自行去計畫地址尋找答案~~~

    Github 地址:https://github.com/batnoter/batnoter