search

roc-lang / book-of-examples

Software Design by Example in Roc
Other
23 stars 15 forks source link

proposal: use Jekyll/GitHub Pages _temporarily_ to build a website for this material #50

Closed gvwilson closed 1 month ago

gvwilson commented 1 month ago

I propose using standard GitHub Pages tooling (i.e., Jekyll) to build a website for this material while we are working on rough drafts, and to move to something Roc-based once we have a better idea of what we need.

Pros:

  1. Immediately available: see the website branch of this repo, which uses a template from previous book-ish projects I've worked on.
  2. Having something up right away will give us a better idea of what we actually want from whatever static site generator we eventually choose.
  3. "Use GHP's default" can save a lot of arguing over what's the best SSG and why.

Cons:

  1. Local preview requires Jekyll.
    • Contributors shouldn't be worried about formatting at this point (@gvwilson can tidy that up as PRs come in if necessary).
    • Jekyll is straightforward to set up for people who do want to preview.
  2. We ought to use a Roc-based SSG.
    • Translation will be low effort, since the templating is very simple.
    • Building this with an off-the-shelf tool will give us a better idea of what we actually need in that SSG.
jwoudenberg commented 1 month ago

This sounds great to me! I like the idea of having something setup early, and then possibly revisit later when we have a roc-based tool that'd be a better fit.

gvwilson commented 1 month ago

closed by 96e9963ab2 - I went with server-side rendering and serving out of docs for now so that I can check things as they come in. I look forward to replacing this all with a Roc-based static site generator :-)