Typer

Typer copied to clipboard

Typer

A diary generator powered by Github issues && React && React-router.

Demo

Usage

1. Install typer

$ (sudo) npm install -g @vueact/typer

2. Init folder

create a folder

$ mkdir diary
$ cd diary
$ typer init

or

$ typer init diary

Then you will see the files tree like this:

-- diary  
 -- index.html  
 -- typer.[hash].js  
 -- vendor.[hash].js  
 -- config.yml  
 -- .gitignore  

3. Configure

Modify the config.yml:

# site title
title: 'Typer'

# github user's name
user: 'stephenLYao'

# issue repo, all diary content from here
repo: 'diary'

# token
token:

Add access token is up to you, however I suggest to do so.

Go to https://github.com/settings/tokens

4. Build

Run build to generate diary

$ typer build

5. Deploy

Now push all files to the repo gh-pages branch which you modify in the config.yml,
and Everything has done, Just have typer :)

Todo

• [ ] add theme configure

Very thanks Mirror!

License

MIT