shikensu haskell

Shīkensu

シーケンス
順序

ファイルのメモリ内表現で一連の関数を実行します。
特定の構造に準拠することなく、静的なWebサイトを簡単に構築します。

マークダウンの例

 import Shikensu
import Shikensu.Contrib ( clone , copyPropsToMetadata , permalink , renameExt , renderContent )
import Shikensu.Contrib.IO ( read , write )

import Data.ByteString ( ByteString )
import Flow
import Prelude hiding ( read )
import qualified Data.Text.Encoding as Text ( decodeUtf8 , encodeUtf8 )


main :: IO Dictionary
main =
  -- This IO operation will read the files matching the glob pattern `src/**/*.md`,
  -- transform them (see the `flow` function) and then write them to the `build` directory.
  dictionary_io


dictionary_io :: IO Dictionary
dictionary_io =
    Shikensu. listRelative [ " src/**/*.md " ] " ./ "
        >>= read
        >>= flow
        >>= write " ./build "


flow :: Dictionary -> IO Dictionary
flow =
       renameExt " .md " " .html "
    .> permalink " index "
    .> clone " index.html " " 200.html "
    .> copyPropsToMetadata
    .> renderContent markdownRenderer
    .> return


markdownRenderer :: Definition -> Maybe ByteString
markdownRenderer def =
    content def
        |> fmap Text. decodeUtf8
        |> fmap Markdown. render
        |> fmap Text. encodeUtf8

これは、 ./srcディレクトリのすべてのマークダウンファイルをリストします
そして、この正確な順序で次のことを行います。

1. 一致した各ファイルの拡張子を.htmlに変更します。
2. 一致した各ファイルのパスを%matched_path/%file_basename/index.%file_extensionに変更します。
3. index.htmlパスを持つファイルのメモリ内コピーを作成します。
4. 各定義の情報（別名ファイル）をメタデータの「オブジェクト」にコピーします（そのため、コンテンツレンダラーでその情報を使用できます）。
5. 各定義のcontentプロパティをマップします（この場合、マークダウンをレンダリングしています）。
6. {post-flow} ./buildディレクトリに書き込みます。

なぜ？

これにより、静的なWebサイトを構築するためのワークフローを簡単に定義できるため、より具体的には次のとおりです。

• 何が起こっているのかを明確に概要してください。
• メモリでたくさんのアクションを実行してから、一度にディスクに書き込みます。
• プロジェクト内の他のファイルに関する情報のリストを作成し、たとえばテンプレートと共有できます。

使用例

• 簡単な例
• 少し複雑な例