diary

Track of everything in your life. It's not only a diary but also a github pages generator. 🍺

Features

• a calendar powered by Pikaday
• code highlight powered by highlight.js
• incremental compile *.md to *.html
• universal rendering
• SEO friendly

Installation

Install everything you need:

$ npm i

Usage

1. configure paths through config.js.
2. write your diaries in Markdown, save them to archives.
3. issue $ npm run build:prod.
4. deploy via $ npm run deploy

Development

Auto-compile after any changes:

$ npm run compile:dev

We can make use of webpack-dev-server to setup our devServer:

$ npm run dev:server

All in one command:

$ npm run dev

Production

In production, we need transform *.md to *.html, compile all scripts and bundle them into single file. To do these, just issue:

$ npm run build:prod

Deploy

To deploy a static site to gh-pages, just:

$ npm run deploy

RoadMap

• dev: add a dev server
• calendar: only link days which have diary
• page: switch among pages without refresh
• diary: beautify
• diary: highlight code
• compiler: incremental compilation
• deploy: scripts to deploy github pages

Author

Micooz

LICENSE

MIT