gin-haskell

Do you want to use your github issues as a static website like this? Gin can help you!

Gin is a project written in haskell which can parser your posts and transform them to github issues automatically.

Features

✅ Support Markdown grammar that Github supports (because I just upload your post with a few midifications 😜)

✅ Support creating and modifying your issues posts locally

✅ Support LaTeX grammar

✅ Support post tags

✅ Support some extension grammars

There is an example.

Installation

Please install cabal or haskell-platform first.

git clone https://github.com/zeqing-guo/gin-haskell.git & cd gin-haskell
cabal sandbox init --only-dependencies
cabal install

Usage

➜  gin -h
Usage: gin [-inphv] [file]
  -i DIR   --init=DIR  Create a blog including a config file and an example post
  -n FILE  --new=FILE  Create a post
  -p       --publish   Publish new and modified posts on Github
  -h       --help      Print this help message
  -v       --version   Show gin's version

➜  gin -i blog
Copy data to blog

➜  cd blog 
➜  gin -n "a new post"
Create post/2015-12-12 a new post.md

➜  echo "\n> hello world" >> post/2015-12-12\ a\ new\ post.md
➜  gin -p 
Upload a new post...
All posts have been updated

Note that you need to fill the _config.yml file to make gin work.

You can get a github token from https://github.com/settings/tokens, and public_repo is enough.

You can insert your copyright statement using {{ copyright }}.

TODO List

1. Test on Windows
2. Improving performamce
3. Refactoring

BTW, the name Gin is from Gintama (銀魂) which is a funny comic. I hope you'll like it 😈