Use Cases

Github Pages

Thank GitHub, we have a great place to host static blogs.

If you want to learn about Github Pages, head over to GitHub Pages.

If you create a repository named (now it’s, its master branch will be served on GitHub Pages.

If you create a branch named gh-pages on any repository, this branch will be served on GitHub Pages.

GitHub Pages is a static files HTTP server, free to use and no bandwidth limiting.

Here’s a short tutorial to use lilac on github pages.

Create a repo for blog on GitHub, and then open a shell:

$ mkdir && cd
$ git init
$ git remote add origin

It’s a good habit to ignore spam files:

$ vim .gitignore

we should add this to .gitignore:


Now make the first commit:

$ git add .gitignore
$ git commit -m 'init commit'
$ git push origin master

It’s time to deploy lilac:

$ lilac deploy

I recommend you to add theme as git submodule(need to remove the auto generated theme directory):

$ rm less -rf
$ git submodule add git:// less

You may take a look at Quick Start for customization.

And start writing:

$ make serve

Let’s deploy the site to GitHub’s Pages:

$ git add .
$ git commit -m 'deploy my blog'
$ git push origin master

GitHub will send you an email once your blog is ready.

Custom Domain

You can set up a custom domain with github pages, just create a file named CNAME for your site, and write your domain in it(sample: CNAME).

After this, create a CNAME record pointing to on the domain panel, more information is on github pages help.

Host Blog in Sub Directory

If your blog must run from a sub-directory, the main scenario being if your blog will be hosted on a GitHub Project Page, take a look at this configuration: root_path.

Fork me on GitHub