使用 hakyll 構建靜態(tài)站點

什么是 hakyll

hakyll 是類似于 jekyll 的一個用來搭建靜態(tài)站點的工具

hakyll 與 jekyll 的不同

hakyll 與其他大多數(shù)同類工具相比擁有非常大的靈活性切威,github 默認的靜態(tài)網頁生成器 jekyll 是一個遵循約定大于配置的工具,使用 jekyll 就必須遵循它的約定。
比如博文需要以 yy-mm-dd 開頭的文件名形式存放在 posts 文件夾下彤蔽。
而 hakyll 就擁有更大的靈活性宰闰,hakyll 的哲學在于,用戶書寫內容收厨,hakyll 負責把這些內容轉化成不同的展現(xiàn)形式柒啤。
這樣生成的站點形式就不局限于博客,也可以包含 slides 或者 pdf 之類的內容龄砰。

hakyll 的安裝與基本使用

hakyll 使用非常高大上的 haskell 語言編寫,所以要使用 hakyll 就需要
haskell 環(huán)境讨衣。在 mac 下的安裝非常簡單:

  brew install ghc cabal-install

安裝完成后記得把 $HOME/.cabal/bin 加入到 $PATH换棚。
然后就可以新建一個站點了

  $ hakyll-init my-site
  $ cd my-site
  $ ghc --make -threaded site.hs
  $ ./site build
  $ ./site watch

打開 http://localhost:8000/ 就能看到默認生成的站點了,如果你只想像使用 jekyll 一樣使用 hakyll 的話反镇,到這里就夠了固蚤,同樣在 posts 文件夾下書寫你的博文就可以了。

hakyll 的高級功能

如果你想領略 hakyll 的強大而靈活的配置歹茶,那么請往下看夕玩。

hakyll 的工作原理

如果你照著上面的方式安裝并初始化了 hakyll 的話你弦,你的站點文件結構就會類似于

  .
  ├── README.md
  ├── about.rst
  ├── contact.markdown
  ├── css
  │   └── default.scss
  ├── images
  │   └── haskell-logo.png
  ├── index.html
  ├── posts
  │   └── use-hakyll-to-build-static-website.org
  ├── site
  ├── site.hi
  ├── site.hs
  ├── site.o
  └── templates
      ├── archive.html
      ├── default.html
      ├── post-list.html
      └── post.html

這樣, 其實除了 site 開頭的幾個文件以外 (site 是編譯好的二進制文件,
有100mb 左右大小, 記得不要納入版本控制!),其他都是靜態(tài)文件燎孟,且結構是可以隨便定義的禽作。其中 site.hs 可以認為是 hakyll 的配置文件,打開它就會看到一大堆看(高)不(大)懂(上)的 haskell 代碼揩页。

稍微觀察一下就會發(fā)現(xiàn), 其中有三個關鍵詞

  • match
  • route
  • compile

match 就是匹配, 后面的文件名是你站點目錄下的源文件, 比如 'css/*' 就指代
css 文件夾下的所有文件

route 和我們通常程序中所有的路由有點不同, 指的是 match
到的文件會被放置在編譯好的站點的位置(默認是 site 文件夾)

compile 就像是一個管道旷偿。一個資源,從 match (頭) 到 route(尾)的過程中需要做的轉換工作爆侣,比如 markdown -> html萍程, 或者壓縮混淆等。

這樣一來 hakyll 的結構就很清楚了兔仰,用戶提供原始的數(shù)據(jù)茫负,然后 hakyll 就去編譯他們并且放置到正確的位置。

下面舉幾個實際的例子乎赴,來表現(xiàn)一下 hakyll 的強大忍法。

sass 支持

  -- 使用 compass 來處理 scss 樣式
  match (fromList ["sass/main.scss", "sass/blog.scss"]) $ do
      route   $ setExtension "css"
      compile $ getResourceString >>=
          withItemBody (unixFilter "sass" ["-s", "--scss", "-I", "sass/"]) >>=
          return . fmap compressCss

創(chuàng)建不存在的頁面

  create ["archive.html"] $ do
      route idRoute
      compile $ do
          posts <- recentFirst =<< loadAll "posts/*"
          let archiveCtx =
                  listField "posts" postCtx (return posts) `mappend`
                  constField "title" "Archives"            `mappend`
                  defaultContext
          makeItem ""
              >>= loadAndApplyTemplate "templates/archive.html" archiveCtx
              >>= loadAndApplyTemplate "templates/default.html" archiveCtx
              >>= relativizeUrls

這個例子中 archive.html 這個頁面原本是不存在的,里面的內容都是動態(tài)獲取的无虚,它讀取了 posts 下的所有文件缔赠,然后讀取他們的 title 屬性, 然后列出來,這和 jekyll 的讀取一個對象的屬性并循環(huán)出來(命令式編程風格)不同友题,畢竟 haskell 是函數(shù)式語言嗤堰。

幻燈片

  match "slides/*" $ do
      route   $ setExtension "html"
      compile $ getResourceString >>=
          withItemBody (unixFilter "pandoc" ["-s", "--mathml", "-i", "-t", "dzslides"])

使用強大的 pandoc,直接就把 markdown 文件變成 slides 了度宦。

真實的例子

這里 列出了很多使用 hakyll 的網站踢匣,都有源碼在 github 上,可供參考戈抄。

總結

hakyll 將 Haskell 的函數(shù)式編程思想帶到了靜態(tài)網站的構建中离唬,學習使用 hakyll 對理解函數(shù)式編程是很有幫助的。

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末划鸽,一起剝皮案震驚了整個濱河市输莺,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌裸诽,老刑警劉巖嫂用,帶你破解...
    沈念sama閱讀 210,914評論 6 490
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異丈冬,居然都是意外死亡嘱函,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 89,935評論 2 383
  • 文/潘曉璐 我一進店門埂蕊,熙熙樓的掌柜王于貴愁眉苦臉地迎上來往弓,“玉大人疏唾,你說我怎么就攤上這事『疲” “怎么了槐脏?”我有些...
    開封第一講書人閱讀 156,531評論 0 345
  • 文/不壞的土叔 我叫張陵,是天一觀的道長缴淋。 經常有香客問我准给,道長,這世上最難降的妖魔是什么重抖? 我笑而不...
    開封第一講書人閱讀 56,309評論 1 282
  • 正文 為了忘掉前任露氮,我火速辦了婚禮,結果婚禮上钟沛,老公的妹妹穿的比我還像新娘畔规。我一直安慰自己,他們只是感情好恨统,可當我...
    茶點故事閱讀 65,381評論 5 384
  • 文/花漫 我一把揭開白布叁扫。 她就那樣靜靜地躺著,像睡著了一般畜埋。 火紅的嫁衣襯著肌膚如雪莫绣。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,730評論 1 289
  • 那天悠鞍,我揣著相機與錄音对室,去河邊找鬼。 笑死咖祭,一個胖子當著我的面吹牛掩宜,可吹牛的內容都是我干的。 我是一名探鬼主播么翰,決...
    沈念sama閱讀 38,882評論 3 404
  • 文/蒼蘭香墨 我猛地睜開眼牺汤,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了浩嫌?” 一聲冷哼從身側響起檐迟,我...
    開封第一講書人閱讀 37,643評論 0 266
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎码耐,沒想到半個月后追迟,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經...
    沈念sama閱讀 44,095評論 1 303
  • 正文 獨居荒郊野嶺守林人離奇死亡伐坏,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 36,448評論 2 325
  • 正文 我和宋清朗相戀三年怔匣,在試婚紗的時候發(fā)現(xiàn)自己被綠了握联。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片桦沉。...
    茶點故事閱讀 38,566評論 1 339
  • 序言:一個原本活蹦亂跳的男人離奇死亡每瞒,死狀恐怖,靈堂內的尸體忽然破棺而出纯露,到底是詐尸還是另有隱情剿骨,我是刑警寧澤,帶...
    沈念sama閱讀 34,253評論 4 328
  • 正文 年R本政府宣布埠褪,位于F島的核電站浓利,受9級特大地震影響,放射性物質發(fā)生泄漏钞速。R本人自食惡果不足惜贷掖,卻給世界環(huán)境...
    茶點故事閱讀 39,829評論 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望渴语。 院中可真熱鬧苹威,春花似錦、人聲如沸驾凶。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,715評論 0 21
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽调违。三九已至窟哺,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間技肩,已是汗流浹背且轨。 一陣腳步聲響...
    開封第一講書人閱讀 31,945評論 1 264
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留亩鬼,地道東北人殖告。 一個月前我還...
    沈念sama閱讀 46,248評論 2 360
  • 正文 我出身青樓,卻偏偏與公主長得像雳锋,于是被迫代替她去往敵國和親黄绩。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 43,440評論 2 348

推薦閱讀更多精彩內容