diff --git a/README.md b/README.md index 3a99cef..80c0b8b 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,49 @@ # github-style +## Install the theme + +```bash +mkdir themes +git submodule add git@github.com:MeiK2333/github-style.git themes/github-style +``` + +## Update the theme + +```bash +cd themes/github-style +git pull +``` + +## Setup About page + +```bash +hugo new about.md +``` + +add `layout = "about"` to `content/about.md` + +``` +--- +title: "About" +date: 2019-10-22T18:46:47+08:00 +layout: "about" +--- + +about me +``` + ## config.toml example ```toml -baseURL = "https://domain.com/" +baseURL = "https://example.com/" title = "GitHub Style" googleAnalytics = "UA-123-456-789" +theme = "github-style" [params] - author = "author" - description = "description" - github = "github" - twitter = "twitter" - email = "email@domain.com" + author = "example" + description = "example" + github = "example" + twitter = "example" + email = "example@domain.com" ``` diff --git a/images/mobile.png b/images/mobile.png new file mode 100644 index 0000000..d03089d Binary files /dev/null and b/images/mobile.png differ diff --git a/images/screenshot.png b/images/screenshot.png new file mode 100644 index 0000000..a367bc0 Binary files /dev/null and b/images/screenshot.png differ diff --git a/images/tn.png b/images/tn.png new file mode 100644 index 0000000..5cc4eea Binary files /dev/null and b/images/tn.png differ diff --git a/theme.toml b/theme.toml index ee9cf8e..68f1e27 100644 --- a/theme.toml +++ b/theme.toml @@ -6,8 +6,8 @@ license = "MIT" licenselink = "https://github.com/MeiK2333/github-style/blob/master/LICENSE" description = "github-style hugo theme" homepage = "http://example.com/" -tags = ["blog"] -features = ["github-style"] +tags = ["blog", "google analytics"] +features = ["google analytics"] min_version = "0.41" [author]