Merge pull request #167 from srid/release-1.0

Release 1.0
srid · Oct 4, 2020 · 3368c33 · 3368c33
2 parents 78b42b3 + caebad9
commit 3368c33
Show file tree

Hide file tree

Showing 15 changed files with 40 additions and 44 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # Change Log for rib
 
-## Unreleased
+## 1.0
 
 - Split packages into `rib` and `rib-core`
 

diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ See <https://rib.srid.ca> for full documentation.
 Use ghcid for quicker compilation cycles:
 
 ```bash
-nix-shell --run ghcid
+nix-shell --run "cd rib-core && ghcid"
 ```
 
 To test your changes, clone [rib-sample](https://github.com/srid/rib-sample) and run it using your local rib checkout:

diff --git a/cabal.project b/cabal.project
@@ -0,0 +1,2 @@
+optional-packages:
+  *
diff --git a/guide/2015602.md b/guide/2015602.md
diff --git a/guide/2014302.md → guide/examples.md b/guide/2014302.md → guide/examples.md
@@ -1,6 +1,4 @@
----
-title: Examples
----
+# Examples
 
 * [rib-sample](https://github.com/srid/rib-sample): Use this to get started with
   your own site.

diff --git a/guide/guide.md b/guide/guide.md
@@ -0,0 +1,6 @@
+# Guide
+
+Assuming you have read the [[tutorial]], use this portal to
+understand how to do certain things in Rib.
+
+[[[z:zettels?tag=guide]]]
diff --git a/guide/index.md b/guide/index.md
@@ -1,6 +1,4 @@
----
-title: Rib
----
+# Rib
 
 [Rib](https://github.com/srid/rib) is a Haskell **static site generator** based
 on Shake, with a delightful development experience.
@@ -19,7 +17,7 @@ reinventing their capabilities. Time spent using rib is time spent learning them
 - Remain as simple as possible to use
 - Reproducible and a delightful workflow enabled by Nix, ghcid and fsnotify.
 
-See [[[2015601]]] to get a feel for what your code may look like.
+See [[[preview]]] to get a feel for what your code may look like.
 
 
 ## Getting Started
@@ -30,7 +28,7 @@ repository, [**rib-sample**](https://github.com/srid/rib-sample), from Github.
 
 ## Next
 
-* [[[2014301]]]
-* [[[2015602]]]
-* [[[2014302]]]
+* [[[tutorial]]]
+* [[[guide]]]
+* [[[examples]]]
 
diff --git a/guide/neuron.dhall b/guide/neuron.dhall
@@ -1,11 +1,13 @@
-{ siteTitle =
-    "Rib"
-, siteBaseUrl =
-    Some "https://rib.srid.ca"
-, theme =
-    "green"
-, editUrl =
-    Some "https://github.com/srid/rib/edit/master/guide/"
-, minVersion =
-    "0.2"
+{ siteTitle = "Rib"
+, siteBaseUrl = Some "https://rib.srid.ca"
+, theme = "green"
+, editUrl = Some "https://github.com/srid/rib/edit/master/guide/"
+, aliases =
+  [ "2014302:examples"
+  , "2015602:guide"
+  , "2014301:tutorial"
+  , "2015604:typed-routes"
+  , "2015603:syntax-highlighting"
+  , "2015601:preview"
+  ]
 }
diff --git a/guide/2015601.md → guide/preview.md b/guide/2015601.md → guide/preview.md
@@ -1,6 +1,4 @@
----
-title: Quick Preview
----
+# Quick Preview
 
 Here is how your code may look like if you were to generate your static site
 using Rib:

diff --git a/guide/2015603.md → guide/syntax-highlighting.md b/guide/2015603.md → guide/syntax-highlighting.md
@@ -1,9 +1,10 @@
 ---
-title: Enable Syntax Highlighting
 tags:
     - guide
 ---
 
+# Enable Syntax Highlighting
+
 Use Pandoc to add syntax highlighting support to your rib site.
 
 1. Import the desired style from Pandoc

diff --git a/guide/2014301.md → guide/tutorial.md b/guide/2014301.md → guide/tutorial.md
@@ -1,6 +1,4 @@
----
-title: Tutorial
----
+# Tutorial
 
 Although Rib is at its core a Haskell library (and meant to be used as one, rather than as a framework), it provides toolset (based on nix, ghcid, fsnotify, etc.) to make working with static sites pleasant.
 
@@ -19,7 +17,7 @@ content/  default.nix  Main.hs  README.md  rib-sample.cabal
 The three key items here are:
 
 1. `Main.hs`: Haskell source containing the DSL of the HTML/CSS of your site.
-   See [[2015601]].
+   See [[preview]].
 2. `content/`: The source content (eg: Markdown sources and static files)
 3. `dest/`: The target directory, excluded from the git repository, will contain
    _generated_ content (i.e., the HTML files, and copied over static content)

diff --git a/guide/2015604.md → guide/typed-routes.md b/guide/2015604.md → guide/typed-routes.md
@@ -1,14 +1,15 @@
 ---
-title: Typed Routes
 tags:
     - guide
 ---
 
+# Typed Routes
+
 Rib includes an optional route system based on
 [GADT](https://ghc.gitlab.haskell.org/ghc/doc/users_guide/exts/gadt.html)s than
 can be used to define safe and structured routes for your site. The sample repo
-used in [[2014301]] already uses routes, and you can see the entire code in
-[[2015601]] to see all of this would fit together in a static site
+used in [[tutorial]] already uses routes, and you can see the entire code in
+[[preview]] to see all of this would fit together in a static site
 generator.
 
 

diff --git a/rib-core/rib-core.cabal b/rib-core/rib-core.cabal
@@ -1,6 +1,6 @@
 cabal-version: 2.4
 name: rib-core
-version: 0.13.0.0
+version: 1.0.0.0
 license: BSD-3-Clause
 copyright: 2019 Sridhar Ratnakumar
 maintainer: [email protected]

diff --git a/rib-core/src/Rib/Cli.hs b/rib-core/src/Rib/Cli.hs
@@ -74,7 +74,7 @@ cliParser inputDirDefault outputDirDefault = do
           )
       )
   ~(inputDir, shakeDbDir) <-
-    fmap (mapToSnd shakeDbDirFrom) $
+    fmap (toSnd shakeDbDirFrom) $
       option
         directoryReader
         ( long "input-dir"

diff --git a/rib/rib.cabal b/rib/rib.cabal
@@ -1,6 +1,6 @@
 cabal-version: 2.4
 name: rib
-version: 0.13.0.0
+version: 1.0.0.0
 license: BSD-3-Clause
 copyright: 2019 Sridhar Ratnakumar
 maintainer: [email protected]