Skip to content

Latest commit

 

History

History
87 lines (58 loc) · 3.32 KB

README.md

File metadata and controls

87 lines (58 loc) · 3.32 KB
Raw

Website of Indian Curry

Build Staus In Progress

This is the hakyll source code that powers the website https://indian-curry.github.io. While the master branch contains the generated files, the actual source resides in the develop branch.

Building the website

The website uses the Hakyll static website generator. We recommend using stack to build the site.

git clone [email protected]/your-user-name/indian-curry.github.io

cd indian-curry.github.io   # go to the root of the indian curry directory.

stack setup                 # set up stack
stack build website         # build hakyll executable
stack exec  website build   # should build the site
stack exec  website watch   # run preview server on localhost:8000
stack exec  website check   # check for broken links
git checkout -b topic       # Create a topic branch for developing.
  • When done push your topic branch and send pull request.
git push origin -u topic # and send pull request from topic

Unconventional branch structure.

This repository has two branches the master and develop. Since this repository servers also as github pages for our website, the contents of the master branch are the raw html/css/media files are not of interest for the developer. The actual source for the website resides in the develop branch. For more details see the tutorial https://jaspervdj.be/hakyll/tutorials/github-pages-tutorial.html.

Editing news items.

One of the most common tasks is editing the news item or creating a item. You hardly need to know any Haskell to accomplish this. So do not get scared to send in what you think is relevant for this group.

All news items are located in the sub-directory news in this repository. News items are split into three categories each located in a sub-directory of its own:

  1. Posts: These are general news items. These could be short writeups of new projects, experience reports or anything else that might be interesting for the group.

  2. Jobs: Announcements for internship, job opportunity

  3. Events: Hackathons, meetups, conferences etc.

The file name of the news item follow the convention of a blog entry in a hakyll based site i.e. DD-MM-YYYY-title.md. For example, the announcement of a functional programmers meetup in hell can be done by creating an file news/event/29-02-2016-Haskell-Meetup-in-Hell.md.