blog

Source files for chris.bracken.jp
git clone https://git.bracken.jp/blog.git
Log | Files | Refs | Submodules | README | LICENSE

README.md (1139B)

      1 # chris.bracken.jp
      2 
      3 If you were looking for my actual blog, you'd find it at [chris.bracken.jp][blog],
      4 but if you're here, odds are you're looking for the source. You've come to the
      5 right place.
      6 
      7 ## Prerequisites
      8 
      9 To build, you'll need [hugo][hugo_install] installed on your system.
     10 
     11 ## Obtaining the source
     12 
     13 First, clone the repo:
     14 
     15     git clone git://git.bracken.jp/blog.git
     16 
     17 Next, initialise and fetch git submodules:
     18 
     19     git submodule update --init
     20 
     21 ## Starting the dev server
     22 
     23 Fire up hugo's dev server:
     24 
     25     # For the production site:
     26     hugo server
     27     
     28     # To run with draft posts enabled:
     29     hugo server -D
     30 
     31 Follow the on-screen instructions to test the site out locally.
     32 
     33 ## Adding a new post
     34 
     35 To create a new post:
     36 
     37     hugo new post/yyyy-mm-dd-title-of-post.md
     38 
     39 Edit `content/post/yyyy-mm-dd-title-of-post.md` in your favourite editor. When
     40 it's ready to post, remove the `draft` tag from the post header, commit the
     41 changes, and push.
     42 
     43 ## Building and deploying the site
     44 
     45 To build and deploy the site, run:
     46 
     47     ./publish.sh
     48 
     49 [blog]: https://chris.bracken.jp
     50 [hugo_install]: https://gohugo.io/getting-started/installing/