From f1c63e7e50bbfd222c882cc2d09c0195e15b58bb Mon Sep 17 00:00:00 2001 From: foo-dogsquared Date: Thu, 15 Aug 2019 19:28:39 +0800 Subject: [PATCH] Convert README into Asciidoctor --- README.adoc | 40 ++++++++++++++++++++++++++++++++++++++++ README.md | 2 -- 2 files changed, 40 insertions(+), 2 deletions(-) create mode 100644 README.adoc delete mode 100644 README.md diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..aa1b7db --- /dev/null +++ b/README.adoc @@ -0,0 +1,40 @@ += blog + +My blog. Yes. My blog. + +As of 2019-08-15, this blog uses https://gohugo.io/[Hugo] as +its static site generator (SSG). It is currently under +rebranding and migration from https://jekyllrb.com/[Jekyll]. + +== Setting up a development environment +To set up a development environment for this repo, you can +do the following steps: + +* Clone the repo (`git clone `) +* Go to the project directory +* Run the `first-time-setup.sh` script + +Aaaaand you're done. + +== Blog workflow +Here's how my blogging workflow works with this repo: + +* Create a new post (with `hugo new posts/.adoc`) +* Do a pre-write or listing related words into the new document +* Create a layout for the post +* Create a draft +* Edit the draft +* Correct any misspellings and grammar inconsistencies +* Commit the new post +* Publish it (with `deploy.sh`) + +I might have to create a new tool out of creating the post +for this (https://github.com/foo-dogsquared/automate-md[my old tool] might +do some upgrade for that). + +== Other notes + +* I write with https://asciidoctor.org/[Asciidoctor] so it'll need it to +be installed. +* The theme I used is https://themes.gohugo.io/hugo-theme-terminal/[Terminal] with +some CSS overrides in `static/style.css`. diff --git a/README.md b/README.md deleted file mode 100644 index 1bc485e..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# blog -This is where my blog will be now.