Skip to content

Commit

Permalink
Merge pull request #167 from srid/release-1.0
Browse files Browse the repository at this point in the history
Release 1.0
  • Loading branch information
srid authored Oct 4, 2020
2 parents 78b42b3 + caebad9 commit 3368c33
Show file tree
Hide file tree
Showing 15 changed files with 40 additions and 44 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Change Log for rib

## Unreleased
## 1.0

- Split packages into `rib` and `rib-core`

Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 2 additions & 0 deletions cabal.project
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
optional-packages:
*
8 changes: 0 additions & 8 deletions guide/2015602.md

This file was deleted.

4 changes: 1 addition & 3 deletions guide/2014302.md → guide/examples.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
title: Examples
---
# Examples

* [rib-sample](https://github.com/srid/rib-sample): Use this to get started with
your own site.
Expand Down
6 changes: 6 additions & 0 deletions guide/guide.md
Original file line number Diff line number Diff line change
@@ -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]]]
12 changes: 5 additions & 7 deletions guide/index.md
Original file line number Diff line number Diff line change
@@ -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.
Expand All @@ -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
Expand All @@ -30,7 +28,7 @@ repository, [**rib-sample**](https://github.com/srid/rib-sample), from Github.

## Next

* [[[2014301]]]
* [[[2015602]]]
* [[[2014302]]]
* [[[tutorial]]]
* [[[guide]]]
* [[[examples]]]

22 changes: 12 additions & 10 deletions guide/neuron.dhall
Original file line number Diff line number Diff line change
@@ -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"
]
}
4 changes: 1 addition & 3 deletions guide/2015601.md → guide/preview.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
3 changes: 2 additions & 1 deletion guide/2015603.md → guide/syntax-highlighting.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
6 changes: 2 additions & 4 deletions guide/2014301.md → guide/tutorial.md
Original file line number Diff line number Diff line change
@@ -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.

Expand All @@ -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)
Expand Down
7 changes: 4 additions & 3 deletions guide/2015604.md → guide/typed-routes.md
Original file line number Diff line number Diff line change
@@ -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.


Expand Down
2 changes: 1 addition & 1 deletion rib-core/rib-core.cabal
Original file line number Diff line number Diff line change
@@ -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: srid@srid.ca
Expand Down
2 changes: 1 addition & 1 deletion rib-core/src/Rib/Cli.hs
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ cliParser inputDirDefault outputDirDefault = do
)
)
~(inputDir, shakeDbDir) <-
fmap (mapToSnd shakeDbDirFrom) $
fmap (toSnd shakeDbDirFrom) $
option
directoryReader
( long "input-dir"
Expand Down
2 changes: 1 addition & 1 deletion rib/rib.cabal
Original file line number Diff line number Diff line change
@@ -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: srid@srid.ca
Expand Down

0 comments on commit 3368c33

Please sign in to comment.