Skip to content
/ coil Public

Coil is a minimalistic static content engine written in elixir

License

Notifications You must be signed in to change notification settings

badosu/coil

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

51 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Coil

Coil is a minimalistic blog engine written in elixir.

Install

You must have the latest stable version of elixir installed.

Choose one of the following:

Clone a sample repo

git clone https://github.com/badosu/coilblog
cd coilblog && mix deps.get
```

### Use the `mix coil` command

Clone the repo, fetch dependencies and compile:

````bash
git clone https://github.com/badosu/coil
cd coil && mix do deps.get, compile

Bootstrap a sample coil blog:

mix coil ../my-blog
cd ../my-blog && mix deps.get
```

Usage
-----

Edit `config.yml`.

Add an article: `mix post`

And run:

````bash
PORT=8080 mix run --no-halt

Deploy to Heroku:

heroku create --buildpack "https://github.com/goshakkk/heroku-buildpack-elixir.git"
git push heroku master

Customize

Resources

Any file stored on the public/ folder will be served at the /public route

Templates

Templates are stored in the templates/ folder, and are embedded elixir files

See the EEx docs

  • layout.html.eex The template in which all other templates are embedded
  • index.html.eex Renders the home page
  • article.html.eex Renders the article page
  • archives.html.eex Renders the archives page
  • index.xml.eex Renders the rss feed

Articles

The content should be plain markdown.

Articles are stored in articles/YYYY-mm-dd-article-title.md

License

The MIT License, see LICENSE

About

Coil is a minimalistic static content engine written in elixir

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •