btfak/useHexo.md

Created May 26, 2016 09:41

Star (245) You must be signed in to star a gist
Fork (57) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/btfak/18938572f5df000ebe06fbd1872e4e39.js"></script>
Save btfak/18938572f5df000ebe06fbd1872e4e39 to your computer and use it in GitHub Desktop.

Download ZIP

How to use Hexo and deploy to GitHub Pages

Raw

how_to_use_Hexo_on_GitHub_Page.md

Quick Start

1. Install Hexo

$ sudo npm install hexo-cli -g

$ hexo -v
hexo-cli: 0.1.9
os: Darwin 14.3.0 darwin x64
http_parser: 2.3
node: 0.12.7
v8: 3.28.71.19
uv: 1.6.1
zlib: 1.2.8
modules: 14
openssl: 1.0.1p

2. Create a directory for your new blog

$ hexo init yt8yt.github.io
INFO  Copying data to ~/source/yt8yt.github.io
INFO  You are almost done! Don't forget to run 'npm install' before you start blogging with Hexo!

$ cd yt8yt.github.io

$ npm install

3. Run a test server for your new blog on Mac

$ hexo server
INFO  Hexo is running at http://0.0.0.0:4000/. Press Ctrl+C to stop.

4. Set information for your new blog

https://hexo.io/docs/configuration.html

$ vi _config.yml

~~~~~~~~~~~~~~~~~~ _config.yml ~~~~~~~~~~~~~~~~~~
# Site
title: yt8yt's note
subtitle:
description: yt8yt's personal blog
author: yt8yt
language:
timezone: Japan

# URL
## If your site is put in a subdirectory, set url as 'http://yoursite.com/child' and root as '/child/'
url: http://yt8yt.github.io/
root: /
permalink: :year/:month/:day/:title/
permalink_defaults:

5. Set information to use Git

https://github.com/hexojs/hexo-deployer-git

$ npm install hexo-deployer-git --save
$ vi _config.yml

~~~~~~~~~~~~~~~~~~ _config.yml ~~~~~~~~~~~~~~~~~~
# Deployment
## Docs: http://hexo.io/docs/deployment.html
deploy:
  type: git
  repo: [email protected]:yt8yt/yt8yt.github.io.git
  branch: master

6. Set "watch" before starting your work

"watch" command can monitor your files.
https://hexo.io/docs/generating.html

$ hexo generate --watch

7. Create a new post file

$ hexo new first-post
INFO  Created: ~/***/yt8yt.github.io/source/_posts/first-post.md

8. Edit the above file with Markdown or Hexo's Helper

Hexo's Helper
https://hexo.io/docs/helpers.html
I use Atom with "shift + control + m" :-)
https://atom.io/

9. Delete "source/_posts/hello-world.md"

It's not necessary to deploy.

10. Deploy your new blog!!

https://hexo.io/docs/deployment.html

$ hexo deploy

aginanjar commented Mar 21, 2017

Awesome, thanks for sharing. (y)

thirdgen88 commented May 5, 2017

Agreed, covers all the aspects you need! Thanks!

karthikkrishnadev commented May 15, 2017

Thank you so much! Works like a charm.

CodeCanna commented May 28, 2017

Okay its not working for me...I must have missed something somewhere. I followed the directions but its not working. I commited and pushed the files to github the traditional way prior to finding these instructions, should I clean out the repo and try again?

shengyu commented Jun 5, 2017

Thanks for sharing, it's really helpful.

rankobp commented Jun 18, 2017

Thanks!

gnehz972 commented Jun 28, 2017

best hexo & github page tutorial

agonzalez0515 commented Jul 8, 2017

This is so good! First time using Hexo and this made it so easy.

KINGSABRI commented Aug 21, 2017 •

edited

Loading

Install nodejs, nvm on ubuntu

Install required packages for nodejs

apt update
apt install build-essential libssl-dev
apt install nodejs
apt install npm

Install nvm

wget -qO- https://raw.githubusercontent.com/creationix/nvm/master/install.sh | bash

Install latest stable nodejs version

nvm install stable

update your profile - to find nvm path

source ~/.profile

Install hexo

npm install -g hexo-cli

Sources

triyanarief commented Oct 11, 2017

thanks dude!

wangjuanmt commented Nov 28, 2017

Thanks, it's very useful!

HelloWhist commented Jan 10, 2018

thx

BobHongYuChen commented Jan 24, 2018

thx

ziyoushibo commented Mar 22, 2018

no ssh?

fer commented Apr 10, 2018 •

edited

Loading

Good stuff! Maybe worth to mention to add a CNAME under sources in order to use a custom domain.

garyyu commented Apr 25, 2018

Nice and simple HowTo document~ Thanks!

strongSoda commented Jun 29, 2018

vi _config.yml not working. Says vi is not an internal or external command

ohkimchi commented Jul 15, 2018

Thank you so much, buddy!

initialkommit commented Jul 29, 2018

Thank you. It's useful!

ghost commented Aug 11, 2018

i changed my theme, my theme apply in local but i cannot reflect it to github page :((( even deploy many times

Jonnypeng commented Oct 15, 2018

thank you.it's useful!

yusupscopes commented May 4, 2019

Thank you! it's well explained!

erlange commented Jul 8, 2019

This is the most concise and useful hexo tutorial. Thanks!

sirkaushalkumar commented Sep 9, 2019

This post is really helpful and awesome. Thank you for creating the piece.

thanhdx0 commented Mar 21, 2020

Thank you! Your post helps me a lot while I'm stuck with using Travis-CI.

loyio commented Apr 28, 2020

thanks,great tutorial

devhector commented Jan 31, 2021

Thanks to share!! 🤙

alifma commented Jul 8, 2023

Still works on July 2023, thanks mate!

ysy950803 commented Jul 13, 2023

Nice!

PurplePlanen commented Dec 3, 2024

Thanks!

btfak/useHexo.md

Quick Start

1. Install Hexo

2. Create a directory for your new blog

3. Run a test server for your new blog on Mac

4. Set information for your new blog

5. Set information to use Git

6. Set "watch" before starting your work

7. Create a new post file

8. Edit the above file with Markdown or Hexo's Helper

9. Delete "source/_posts/hello-world.md"

10. Deploy your new blog!!

aginanjar commented Mar 21, 2017

Uh oh!

thirdgen88 commented May 5, 2017

Uh oh!

karthikkrishnadev commented May 15, 2017

Uh oh!

CodeCanna commented May 28, 2017

Uh oh!

shengyu commented Jun 5, 2017

Uh oh!

rankobp commented Jun 18, 2017

Uh oh!

gnehz972 commented Jun 28, 2017

Uh oh!

agonzalez0515 commented Jul 8, 2017

Uh oh!

KINGSABRI commented Aug 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Install nodejs, nvm on ubuntu

Uh oh!

triyanarief commented Oct 11, 2017

Uh oh!

wangjuanmt commented Nov 28, 2017

Uh oh!

HelloWhist commented Jan 10, 2018

Uh oh!

BobHongYuChen commented Jan 24, 2018

Uh oh!

ziyoushibo commented Mar 22, 2018

Uh oh!

fer commented Apr 10, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

garyyu commented Apr 25, 2018

Uh oh!

strongSoda commented Jun 29, 2018

Uh oh!

ohkimchi commented Jul 15, 2018

Uh oh!

initialkommit commented Jul 29, 2018

Uh oh!

ghost commented Aug 11, 2018

Uh oh!

Jonnypeng commented Oct 15, 2018

Uh oh!

yusupscopes commented May 4, 2019

Uh oh!

erlange commented Jul 8, 2019

Uh oh!

sirkaushalkumar commented Sep 9, 2019

Uh oh!

thanhdx0 commented Mar 21, 2020

Uh oh!

loyio commented Apr 28, 2020

Uh oh!

devhector commented Jan 31, 2021

Uh oh!

alifma commented Jul 8, 2023

Uh oh!

ysy950803 commented Jul 13, 2023

Uh oh!

PurplePlanen commented Dec 3, 2024

Uh oh!

KINGSABRI commented Aug 21, 2017 •

edited

Loading

fer commented Apr 10, 2018 •

edited

Loading