無需開發部署,秒建優雅的開源專案文件,這個工具用起來賊爽

macrozheng發表於2021-10-01
之前介紹過幾款搭建開源專案文件的工具,有Docsify、VuePress和Hexo。這些工具有個共同點,需要一些開發部署的工作,部署基本依賴Github Pages或者自建伺服器。那麼有沒有那種開箱即用的工具呢,最近發現很多開源專案都用語雀來搭建文件網站,體驗了一把,非常不錯,推薦給大家!

SpringBoot實戰電商專案mall(50k+star)地址:https://github.com/macrozheng/mall

語雀簡介

語雀是新一代的雲端知識庫,可以寫出像書一樣的專案文件,擁有專業好用的編輯器(支援Markdown轉換),方便的團隊協同功能。

主要使用場景如下:

  • 個人筆記:語雀知識庫具有公開私有功能,私有的知識庫完全可以當線上雲筆記使用,可以方便我們記錄點滴,沉澱知識。
  • 專欄部落格:如果你不想自己搭建部落格網站的話,可以直接生成。
  • 專案文件:可以多人協作的專案文件,你見過沒?
  • 官方文件:可以作為產品說明和幫助手冊。

效果展示

我們先來看下成品效果,開箱即用,介面還是挺不錯的!

核心概念

在使用語雀之前,我們需要對其中的概念有所瞭解。下面介紹下這些核心概念,然後再展示下對應的介面。
  • 首先我們來看下各個核心概念的關係圖,這對理解這些概念很有幫助:

  • 空間:空間類似於公司或組織的概念,在空間中我們可以管理團隊、知識庫、知識等內容。

  • 團隊:空間下的團隊可以和你實際組織結構進行掛鉤,如部門團隊,專案組等。

  • 知識庫:知識庫是知識內容的載體,就好比一本書一樣,你可以在知識庫裡對知識內容進行重新組織和分類。

  • 知識:知識庫中的內容,可以是文件。

搭建

接下來我們使用語雀來搭建一個開源專案文件,以我的開源電商專案mall為例。

快速搭建

  • 首先我們點選左上角建立空間,用於存放團隊和知識庫;

  • 然後選擇建立知識庫,由於我們的知識庫主要用於存放文件,所以選擇文件知識庫,然後輸入名稱、簡介即可;

  • 建立完知識庫之後,我們就可以在知識庫中新增文件了,直接複製之前使用Markdown寫的文件即可,然後點選右上角的立即轉換

  • 轉換成功後顯示效果如下,是不是比自己搭建專案文件網站簡單多了?

  • 這裡值得一提的是,在我們複製文章時,語雀會自動幫我們上傳線上圖片,很多部落格網站也都有這個功能;

  • 如果你想修改知識庫的文件目錄的話,比如我想整個二級目錄,可以使用編排目錄功能;

自定義首頁

其實到這裡,我們已經學會了如何製作一個開源專案文件網站了,但是此時文件網站的首頁只是一個目錄,這樣未免有些單調,如果我們想要首頁內容更豐富些,我就需要建立團隊,然後自定義團隊的首頁即可;
  • 首先我們來建立個團隊,選擇官方文件模板;

  • 然後填寫名稱、簡介、頭像即可;

  • 然後我們可以通過自定義首頁功能,使用圖形化介面來完成一個首頁,下面是我已經完成好的首頁效果;

  • 這裡我新增了搜尋、知識庫、自定義內容三個模組,如果你想首頁更豐富些,可以新增更多模組試試;

  • 這裡最好在你的知識庫的設定頁,把你的知識庫轉移到建立的團隊中去;

  • 接下來訪問你的團隊主頁,一個標準的開源專案文件網站就誕生了。

公開訪問

如果你想搭建一個私有的文件網站的話,上面的操作基本能滿足需求了,但如果你想搭建一個公開的文件網站的話,還需要如下操作。
  • 很遺憾的是,在新建空間中的無論團隊還是知識庫,都是沒法設定讓網際網路上的所有人訪問的,僅支援如下三種訪問許可權;

  • 要想團隊可以公開訪問,我們需要在預設的個人空間中,建立知識小組,可以選擇官方文件模板;

  • 此時我們可以發現,團隊的可見範圍變成了網際網路可見,這才是真正公開的團隊;

  • 之後要做的就是把之前的知識庫通過匯入、匯出功能轉移到該團隊中去,匯出功能在知識庫設定->高階設定中,選擇匯出為.lakebook格式;

  • 然後在該知識小組中建立知識庫,設定範圍為網際網路可見,並匯入.lakebook檔案;

  • 之後再按照之前的步驟自定義知識小組的首頁,一個可以公開訪問的開源專案文件網站就誕生了!

總結

通過使用語雀搭建開源專案文件的一波實踐,我們可以發現這種方式確實比使用Docsify來自建網站簡單太多了,既不需要編碼,也不需要買伺服器。怪不得很多開源專案都用它來搭建文件網站,當然語雀的功能還不只這些,用來做線上雲筆記也挺好用的,如果大家感興趣的話,可以自己探索下!

官方網站

https://www.yuque.com/

本文 GitHub https://github.com/macrozheng/mall-learning 已經收錄,歡迎大家Star!

相關文章