Documentation of Nico

Nico is built on nodejs, which means you have to install nodejs. I believe you have installed nodejs, but I'd like to repeat this part.

You can download the package on nodejs.org or through a package manager like apt-get and homebrew.

Installation

Install nico is simple with npm:

$ npm install nico -g

Please install it with -g option, otherwise you can't use it in command line.

If you want a live reload feature, you have to install socket.io by yourself:

$ npm install socket.io -g

Theme

Nico didn't provide a default theme, and it will not provide a default theme in the foreseen future. But I wrote a theme for you, which is one. You can learn how to write your own theme with one.

Let's grab the theme:

$ git clone git://github.com/lepture/nico-one.git _themes/one

Read More

Configure

Nico can't work well without a configuration. Let's create a nico.json:

{
    "source": "content",
    "output": "_site",
    "theme": "_themes/one",
    "permalink": "{{directory}}/{{filename}}.html",
    "writers": [
        "nico.PostWriter",
        "nico.FileWriter",
        "nico.StaticWriter"
    ]
}

Read More

Writing

It's the time for us to write something:

nico.json
content/
  hello-world.md
_themes/
  one/
    templates/
    static/
    ...

And we will edit content/hello-world.md:

# Hello Nico

- pubdate: 2012-12-12

------

Hello World, Hello Nico.

Run the command in the terminal:

$ nico build

It will create a folder _site in the current working directory, and there will be an article hello-world.html.

Learn more about nico in terminal:

$ nico -h
$ nico build -h
$ nico server -h

Read More

Developer Guide

Actually the code of nico is easy to understand.

Bug Report

I keep an issue tracker at GitHub, you can report bugs by openning a new issue. If you want any help, please contact [email protected], English and Chinese are acceptable.

Fork me on GitHub