Skip to content
A static site generator that generates routes based on directories naturally.
Branch: master
Clone or download
Latest commit 91d8d55 Mar 4, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
dist
docs/en Updated docs. Mar 4, 2019
libs Updated pagination. Feb 24, 2019
srcs
.gitignore
Cakefile
LICENSE Created base structure. Aug 30, 2018
README.md
package.json 1.13.7 Feb 24, 2019

README.md

Hikaru

A static site generator that generates routes based on directories naturally.

npm npm GitHub

Install

Hikaru is a command line program (not a module) and you can install it from NPM:

# npm i -g hikaru-coffee

Setup site

$ hikaru i hikaru-site
$ cd hikaru-site
$ npm install

Install theme

Clone theme

Using hikaru-theme-aria as example:

$ git clone https://github.com/AlynxZhou/hikaru-theme-aria.git themes/aria

Or if you want commit the whole site you can use submodule:

$ git submodule add https://github.com/AlynxZhou/hikaru-theme-aria.git themes/aria

Edit config

$ $EDITOR config.yml

Set themeDir to aria

themeDir: aria

Don't forget to config your theme as its README file.

Create src file

Edit file

$ $EDITOR srcs/my-first-post.md

Add front matter

---
title: My First Post
date: 2018-08-08 09:27:00
layout: post
---

Add content

Some content...

<!--more-->

# This is my first post!

Start live server

$ hikaru s

Build static files

$ hikaru b

More

Docs: Here

Default theme ARIA: hikaru-themes-aria

My blog built with Hikaru and ARIA: 喵's StackHarbor

License

Apache-2.0

You can’t perform that action at this time.