haskell-jp / antenna

Home Page:https://haskell.jp/antenna/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Haskell Antenna

Haskellに関する日本語情報の更新をまとめて表示するWebサイトです。

Collect Haskeller's posts in Japanese (like Planet Haskell).

Usage

Haskell stack を使います

Build

$ git clone https://github.com/haskell-jp/antenna.git
$ cd antenna
$ stack build

Run

引数には YAML 形式の設定ファイルを渡します。 設定ファイルの細かいフォーマットはココを参照してください.

$ stack exec -- antenna sites.yaml

実行すると、引数で渡した設定ファイル sites.yaml と同じディレクトリに index.htmlsites.htmlfeed.xml が生成されます。

Docker Image

ビルド方法

$ stack --docker build -j 1 Cabal # if out of memory in docker
$ stack --docker --local-bin-path=./bin install
$ docker build -t ghcr.io/haskell-jp/antenna . --build-arg local_bin_path=./bin

利用方法

$ docker run --rm -v `pwd`:/work haskelljp/antenna antenna sites.yaml

サイトの追加方法

sites.yaml に以下のようにしてフィードの情報を追加して、https://github.com/haskell-jp/antenna/compare より Pull Request を送って下さい。

sites:
  ...
  - title: "サイトの名前"
    author: "サイトの作者"
    url: "サイトの URL"
    feed: "フィードの URL"
    logo:
      # 下のいずれか
      url: "ロゴ画像のURL"
      github: "GitHubのアカウント(GitHubのアカウント画像を利用)"

現状、フィードは Atom と RSS 2.0 に対応しています。

アイコンに関するガイドライン

各サービスのアイコンは以下のガイドラインに沿って使用しています。

About

https://haskell.jp/antenna/

License:MIT License


Languages

Language:Haskell 98.7%Language:Dockerfile 1.3%