commit 8d56084df39971b85f36e4f8f2011f2a86b3808d
parent 42c89f92e3550a7b305213d79f065463fae6a20d
Author: Chris Bracken <chris@bracken.jp>
Date: Fri, 10 Apr 2020 15:42:54 -0700
Reformat README.md with easier-to-read markdown
Use four-space indent rather than triple backtick for code samples.
Diffstat:
| M | README.md | | | 31 | +++++++++++++------------------ |
1 file changed, 13 insertions(+), 18 deletions(-)
diff --git a/README.md b/README.md
@@ -11,34 +11,30 @@ To build, you'll need [hugo][hugo_install] installed on your system.
## Obtaining the source
First, clone the repo:
-```
-git clone git@github.com:cbracken/blog
-```
+
+ git clone git@github.com:cbracken/blog
Next, initialise and fetch git submodules:
-```
-git submodule update --init
-```
+
+ git submodule update --init
## Starting the dev server
Fire up hugo's dev server:
-```
-# For the production site:
-hugo server
-# To run with draft posts enabled:
-hugo server -D
-```
+ # For the production site:
+ hugo server
+
+ # To run with draft posts enabled:
+ hugo server -D
Follow the on-screen instructions to test the site out locally.
## Adding a new post
To create a new post:
-```
-hugo new post/yyyy-mm-dd-title-of-post.md
-```
+
+ hugo new post/yyyy-mm-dd-title-of-post.md
Edit `content/post/yyyy-mm-dd-title-of-post.md` in your favourite editor. When
it's ready to post, remove the `draft` tag from the post header, commit the
@@ -51,9 +47,8 @@ contains a [CNAME][pages_cname] file that tells GitHub the site should resolve
to my personal domain.
To build and deploy the site, run:
-```
-./publish.sh
-```
+
+ ./publish.sh
[blog]: https://chris.bracken.jp
[hugo_install]: https://gohugo.io/getting-started/installing/
