diff options
| author | Jasper Van der Jeugt <m@jaspervdj.be> | 2012-12-14 13:49:51 +0100 |
|---|---|---|
| committer | Jasper Van der Jeugt <m@jaspervdj.be> | 2012-12-14 13:49:51 +0100 |
| commit | 3f42c9cd6f45bb306d622f3ffa175e2a8b0910e1 (patch) | |
| tree | 41cef450bcf59af156b438b0530e7f8880a2440d /src/Hakyll | |
| parent | adc8cf8528e7c9d95e2a8406a02e69cce858f088 (diff) | |
| download | hakyll-3f42c9cd6f45bb306d622f3ffa175e2a8b0910e1.tar.gz | |
Docs on basic rules and routes
Diffstat (limited to 'src/Hakyll')
| -rw-r--r-- | src/Hakyll/Core/Configuration.hs | 8 | ||||
| -rw-r--r-- | src/Hakyll/Core/Routes.hs | 4 |
2 files changed, 6 insertions, 6 deletions
diff --git a/src/Hakyll/Core/Configuration.hs b/src/Hakyll/Core/Configuration.hs index 4d34114..b5b5f77 100644 --- a/src/Hakyll/Core/Configuration.hs +++ b/src/Hakyll/Core/Configuration.hs @@ -28,7 +28,7 @@ data Configuration = Configuration providerDirectory :: FilePath , -- | Function to determine ignored files -- - -- In 'defaultHakyllConfiguration', the following files are ignored: + -- In 'defaultConfiguration', the following files are ignored: -- -- * files starting with a @.@ -- @@ -38,9 +38,9 @@ data Configuration = Configuration -- -- * files ending with @.swp@ -- - -- Note that the files in @destinationDirectory@ and @storeDirectory@ will + -- Note that the files in 'destinationDirectory' and 'storeDirectory' will -- also be ignored. Note that this is the configuration parameter, if you - -- want to use the test, you should use @shouldIgnoreFile@. + -- want to use the test, you should use 'shouldIgnoreFile'. -- ignoreFile :: FilePath -> Bool , -- | Here, you can plug in a system command to upload/deploy your site. @@ -51,7 +51,7 @@ data Configuration = Configuration -- -- You can execute this by using -- - -- > ./hakyll deploy + -- > ./site deploy -- deployCommand :: String , -- | Use an in-memory cache for items. This is faster but uses more diff --git a/src/Hakyll/Core/Routes.hs b/src/Hakyll/Core/Routes.hs index 27e03b1..f653fa5 100644 --- a/src/Hakyll/Core/Routes.hs +++ b/src/Hakyll/Core/Routes.hs @@ -138,8 +138,8 @@ gsubRoute pattern replacement = customRoute $ -------------------------------------------------------------------------------- --- | Compose routes so that @f `composeRoutes` g@ is more or less equivalent --- with @f >>> g@. +-- | Compose routes so that @f \`composeRoutes\` g@ is more or less equivalent +-- with @g . f@. -- -- Example: -- |