道場挑戰 #1 - Laravel 文件瀏覽器

說好的一月一挑戰,開始上菜啦!

TL;DR:假如您比較喜歡看影片的話,傳送門

https://youtu.be/4rmw-0aIZi4

就在前一陣子,我發表了一篇公開宣言,提到在今年 (2018) 會整合 Laravel 道場的資源,每個月在網站上推出新功能。期待能為整個社群生態圈做更多貢獻,也期望能引發正向循環的力量。


挑戰 #1 - 文件瀏覽器

在 1 月份,也就是我們的第一個挑戰,主題就是 文件瀏覽器。其實這一個功能已經醞釀許久、鴨子滑水好一段時間了,也在早先發佈了預覽版給社群知曉,現在總算正式端上桌啦!

Laravel 官方文件繁體中文版

早在 2014 年的時候,我就號召社群志工開始幫忙翻譯 Laravel 官方文件,猶記得當時 4.2 版本翻譯完成時,我們還辦了場慶功宴呢!隨著這項傳統的建立,社群志工們輪番接力地持續翻譯著各版本的文件。不過很可惜的是,目前 Laravel 台灣官網的文件已經壞好一陣子了。所以今年的第一個挑戰,就以實作文件瀏覽器為主題,把這個功能重新在 Larvael 道場網站上建構起來,並給予獨立的子網域,未來只要到: https://docs.laravel-dojo.com 就可以瀏覽完整的繁體中文版 Laravel 官方文件!

全新的 Laravel 官方文件繁體中文版文件瀏覽器

懶人最愛的「複製程式碼到剪貼簿」按鈕

不知道大家有沒有用過 Bootstrap 的官方文件?假如您有使用經驗的話,有沒有發現在 Bootstrap 官方文件裡有一個很貼心的功能,就是在每一個程式碼區塊旁都有一個「Copy」的按鈕。只要點選這個複製按鈕,對應程式碼區塊裡的程式碼就會複製到作業系統的剪貼薄內,再馬上在編輯器裡貼上即可快速修改,完全打中我這懶人的心!

所以,這次在實作文件瀏覽器的功能時,也特別請工作小組為大家把這個功能實作出來,方便懶人如我的人可以迅速的複製官方文件上的程式碼來修改即可。

複製程式碼到剪貼薄按鈕

關鍵字搜尋

Laravel 官方文件的章節在各版本其實常常微調。而我很誠實的說,我從來都背不起來章節結構。每當我要找特定主題時,一定是用「搜尋」的!(應該大家都是吧?有人真的背下來了嗎? XD)

而在此次文件瀏覽器的實作裡,我們也把搜尋功能一併「搬」過來了。先不打自招了,所謂「搬」就是直接對接原文網站的搜尋功能,所以搜尋時請輸入「英文」,也幫助加深一下自己對原文用字的印象。😜

關鍵字搜尋功能

優化後的手機瀏覽體驗

是的,大家都知道現在使用手機瀏覽網頁的比例已經超越了桌機。雖然我也不是這麼確定到底是在怎麼樣的情境底下,會需要在手機上查看 Laravel 的官方文件,但是我們依然遵循 RWD 的精神,盡可能地讓文件瀏覽器在手機上的呈現盡善盡美。

您可以看到在手機版上 Laravel 道場的主選單會依照慣例縮成所謂的漢堡按鈕 (Hamburger button);而文件大綱的選單則是濃縮成一個按鈕在正上方,當點擊時,選單會從左側滑入;而文件版本的部份,則是延用手機版瀏覽器下拉式選單的標準動作,以點擊切換轉盤後更新。

專為手機優化的選單設計

不僅止於此

雖說這個月的挑戰主打的是 Laravel 官方文件瀏覽器,但其實不僅僅於此,對於一位 PHP/Laravel 開發者來說,PHP 正確之道 (PHP: The Right Way) 以及 PSR 標準規範 (PHP Standards Recommendations) 也是兩個很重要的參考文件。而鮮為人知的是,這兩份文件早在 3 年前就開始陸續翻譯出來,只是因為缺乏良好的閱讀介面及宣傳,讓這兩份文件的關注度遠低於其所存在的價值,非常可惜。所以,在這次的挑戰計畫裡,我們也將這兩份文件納入,您可以在網站的下拉式選單裡看到這兩份文件的入口連結 (傳送門:PHP 正確之道PSR 標準規範),期待裡面的內容也能帶給您更多的幫助。

文件瀏覽器也支援瀏覽「PHP 正確之道」及「PSR 標準規範」兩份文件

致謝

說穿了,文件瀏覽器只是個殼,背後真正的英雄是廣大的社群翻譯志工!在這邊要特別感謝社群翻譯志工們這一段時間的努力,您們的無私付出是讓這個社群如此溫馨迷人的原因。另外也要感謝我在 得寬科技 (The Qwan) 的同事們大力支援 (偉呈的後端實作、Nelson的前端調整、正瑋的部署維運)!您們都好棒!


下台一鞠躬

先這樣,這個月的成果介紹就到此告一個段落,希望您會喜歡!假如您認同我們的努力,麻煩按個掌聲,您的表態支持是我們 Laravel 道場長期投入的基石;若您對我們每個月的挑戰有興趣,歡迎持續關注我們,若有任何建議或想法也歡迎與我聯絡!

道場官網:https://www.laravel-dojo.com/
粉絲頁:https://www.facebook.com/LaravelDojo/
部落格:https://medium.com/laraveldojo

Like what you read? Give Shengyou Fan (范聖佑) a round of applause.

From a quick cheer to a standing ovation, clap to show how much you enjoyed this story.