前言
前段時間打算為自己的開源專案做一個主頁，一方面有個好的門面能提升專案的關注度，一方面也能對專案所涉及的資源做一個整合，
其實原先專案已經有一個檔案主頁，比較簡潔，大致長這樣：
其實看起來也還可以是不？
這是用docsify做的，docsify是一款優秀的檔案生成工具，使用起來比較簡單，只需要寫內容的markdown檔案就可以了，支持markdown的大部分語法，并且自己也擴展了部分語法顯示效果，
但是我覺得docsify雖然建檔案還不錯，但用來建專案主頁就有點寒酸了，首先它的定位就是檔案工具，其次主題樣式不夠豐富，頁面的定制性也比較差，就這么一個套路，我對于靜態建站工具有這么幾點要求
- 主題豐富，美觀簡潔，畢竟專案首頁是一個專案的門面，好看是很重要的，
- 搭建簡單，盡可能的只讓我關注內容部分，因為畢竟我對前端并不精通，不想為了建主頁而去學一大堆前端知識，
- 首頁需要層次分明，有那種大專案首頁的既視感，
- 頁面定制化強，不能千篇一律，
- 能夠最大化整合資源，多級目錄，
靜態網站生成工具
我帶著這些要求去比較了當下常見的靜態站點生成工具，最終決定在Hexo，VuePress，Docusaurus這3個當中選，
仔細比較了功能點之后，最終我選擇了Docusaurus，原因是....顏值好看，
當然，顏值是重要的一部分，其次的原因是，Hexo爛大街了，而且個人覺得不太適合做開源專案主頁，VuePress的話雖然也非常優秀，中文支持的也非常好，但是深耕后端的我并太精通Vue，所以選擇性放棄，
Docusaurus是Facebook開源的一個靜態站點生成框架，比較新，國內很可能許多人還不一定知道，但是Facebook的許多新的開源專案網站現在都在使用Docusaurus了，
這是Docusaurus官網主頁：
Docusaurus是基于React構建的，基本上我對專案首頁的要求它都能滿足，可定制化程度也比較高，缺點是檔案中文支持不是很好，雖然Docusaurus1建了一個中文站點，但是檔案只翻譯了部分，并未完全翻譯，Docusaurus2則全是英文檔案，不過耐心點閱讀，應該會很容易知道該怎么做，
建主頁程序
先不廢話，先放上我用Docusaurus搭建之后主頁最后的效果和鏈接供大家觀摩下：
專案主頁鏈接為：
http://bryan31.gitee.io/tlog-website/
是不是還挺像那么回事的吧？大家既然點擊了，那就歡迎幫我這個開源專案在gitee&github上star下哦，
下面我會把建主頁的程序說下，
Docusaurus需要預先裝好node.js和yarn，并且要求node.js的版本在10.15.1及以上，yarn的版本在1.5及以上
你可以通過腳手架來創建初始化的專案站點：
npx @docusaurus/init@next init my-website classic
創建好之后，你就可以進入你的工程，運行
yarn run start
瀏覽器中輸入127.0.0.1:3000，你就能看到以下初始化站點：
當然我沒有在腳手架創建的站點上改，我是在官網上的展示站點中選了一個站點，然后下載他們的原始碼，進行編譯啟動，然后再在基礎上進行修改，
總體來說Docusaurus配置還算簡單，首頁可定制化程度還是很高的，如果你精通react，可以玩出很炫的花樣，如果你不精通react，也可以根據別人的原始碼來修改，可以獲得類似的效果，具體配置檔案，可以參考Docusaurus的中文站點：
https://www.docusaurus.cn/
這里的檔案部分有中文翻譯，
剩下的作業就是編輯markdown，Docusaurus對于markdown的特性作了很多擴展，這是我比較喜歡的部分，有了這些擴展，就可以編輯出很漂亮的檔案，
我比較喜歡的markdown擴展特性有：
Tab：
Docusaurus支持在檔案中嵌入tab標簽，具體效果：
Hignlight塊：
Docusaurus擴展了markdown的語法，使得在檔案中能根據重要程度顯示不同顏色的Highlight塊，具體效果：
代碼的高亮行：
對于在markdown的代碼塊相信很多人都用過，很是方便，還能根據代碼進行著色，但是如果要高亮某幾行代碼，怎么辦，markdown的默認語法是辦不到的，Docusaurus擴展了這個特性，效果如下：
要是多行，也可以這樣定義：{1,4-6,11}，這樣第1行，4到6行，11行，都會被高亮，
除了以上這3個我比較喜歡的特性外，Docusaurus還提供了很細致的擴展，相信這些都是你用得著的，
關于專案主頁
我的開源專案主頁，主要配色是黑金，所以我對css的配色進行一些修改，盡量在整體上保持統一，包括圖示顏色，logo顏色，檔案里面的圖片配色，都是統一的，所以建議在建設主頁的前期，先選好配色，顏色越多不一定看著舒服，簡約統一才是比較好的選擇，
有小伙伴問：你的Logo是哪里來的，是自己設計的嗎？
我不做平面設計，這種應該交給專業的人來做，這個Logo花了幾百塊請人設計的，我覺得一個開源專案也應該傳遞自身的品牌資訊，所以這是值得的，
關于開源專案
TLog是一個新的開源專案，是目前我開源專案中近期主打維護迭代的一個專案，主要致力于在分布式環境中日志的追蹤，它小巧且使用簡單，社區也很活躍，開源1個月來，我收到了很多人的使用反饋，聽取這些反饋進行迭代和新特性開發，
TLog的未來藍圖是做成日志領域集收集，追蹤，統計，分析，展現于一體日志中間件，
Gitee官方曾對TLog進行過社區宣傳，官方曾發文進行過推廣：
https://mp.weixin.qq.com/s/Lsg7s7-b1a8d-n4dsl6bUA
現在TLog擁有了自己的官網主頁，我之后會繼續對這個開源框架進行迭代，希望大家關注，如果喜歡的話，請幫忙請給專案一個star哦，
https://gitee.com/bryan31/TLog
關注作者
「元人部落」是一個堅持做原創的技術科技分享號，希望你能關注我，我每周會出一篇實用的原創技術文章，陪著你一起走，陪你一起成長，關注公眾號回復tlog能加入群聊，我會耐心回答你的每一個使用中的問題，也會長期對這個專案進行長期維護和迭代，
轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/171924.html
標籤：其他
下一篇：2020-10-12