diff --git a/README.md b/README.md index b37f6c2..5e27bdc 100644 --- a/README.md +++ b/README.md @@ -1 +1,80 @@ -## WIP \ No newline at end of file +# Hugo Theme Mini + +A fast, minimalist and responsive hugo theme. + +![./images/screenshot.png](./images/screenshot.png) + + +- [Online demo](nodejh.github.io/hugo-theme-mini) +- [Example Site](exampleSite) + +Features: + +- Fast +- Minimalist +- Responsive +- Archive +- Tags + + +## Installation + + +### As a Hugo Module (recommended) + +> ⚠️ If you installed a [Hugo binary](https://gohugo.io/getting-started/installing/#binary-cross-platform), you may not have Go installed on your machine. To check if Go is installed: +> ``` +> $ go version +> ``` +> Go modules were considered production ready in v1.14. [Download Go](https://golang.org/dl/). + +1. From your project's root directory, initiate the hugo module system if you haven't already: + + ``` + $ hugo mod init github.com// + ``` + +2. Add the theme's repo to your `config.yaml`: + + ```yaml + theme: + - github.com/nodejh/gohugo-theme-mini + ``` + +### As Git Submodule + +Inside the folder of your Hugo site run: + +``` +$ git submodule add https://github.com/nodejh/gohugo-theme-mini.git themes/mini +``` +For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo. + + + +## Getting started + +After installing the theme successfully it requires a just a few more steps to get your site running. + + +### The config file + +Take a look inside the [`exampleSite`](https://github.com/nodejh/gohugo-theme-mini/tree/master/exampleSite) folder of this theme. You'll find a file called [`config.yaml`](https://github.com/nodejh/gohugo-theme-mini/blob/master/exampleSite/config.yaml). To use it, copy the [`config.yaml`](https://github.com/nodejh/gohugo-theme-mini/blob/master/exampleSite/config.yaml) in the root folder of your Hugo site. Feel free to change the strings in this theme. + +You may need to delete the line: `themesDir: ../../` + + +### Logo and favicon + +You can replace the log in the top of each page and favicon with your own images. To do that replace `static/images/avatar.png` and `static/images/favicon.ico` . + + +### Nearly finished + +In order to see your site in action, run Hugo's built-in local server. + +```sh +$ hugo server +``` + +Now enter localhost:1313 in the address bar of your browser. \ No newline at end of file diff --git a/config-example.yaml b/config-example.yaml deleted file mode 100644 index 122067a..0000000 --- a/config-example.yaml +++ /dev/null @@ -1,55 +0,0 @@ -baseURL: https://gohugo.io -languageCode: en-us -title: Hugo Themes -theme: mini -googleAnalytics: your-google-analytics-id -hasCJKLanguage: true -permalinks: - posts: /posts/:title/ - -disqusShortname: your-disqus-shorname - -# Hugo Configure Markup -# see: https://gohugo.io/getting-started/configuration-markup#highlight -markup: - highlight: - guessSyntax: true - style: emacs - - -# Social links in footer, support github,twitter,stackoverflow,facebook -social: - # e.g. - github: 'your-github-link' - twitter: 'your-github-link' - stackoverflow: 'your-github-link' - # facebook: 'your-facebook-link' - - -# Site parameters -params: - # Site Author - author: Author - # Author biography - bio: Software Engineer - # Site Description, used in HTML meat - description: My Blog - enableRSS: true - - # Optional - home: '' # Default: Home - about: '' # Default: About - archive: '' # Default: Archive - subscribe: '' # Default: Subscribe - olderPosts: '' # Default: Older Posts - newerPosts: '' # Default: Newer Posts - copyright: '' - title404: '' # Default: 404 - Page Not Found - subtitle404: '' # Default: The content you're looking for doesn't seem to exist. - readMore: '' # Default: Read More - - # Extra links in navigation - links: - # e.g. - # - name: Project - # path: /project diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 7818e95..f10fb1b 100644 --- a/exampleSite/config.yaml +++ b/exampleSite/config.yaml @@ -1,7 +1,8 @@ baseURL: https://example.com languageCode: en-us -title: Hugo Themes -theme: mini +title: Hugo +theme: hugo-theme-mini +themesDir: ../../ googleAnalytics: your-google-analytics-id hasCJKLanguage: true permalinks: diff --git a/images/archive.png b/images/archive.png deleted file mode 100644 index 43b7fd3..0000000 Binary files a/images/archive.png and /dev/null differ diff --git a/images/screenshot.png b/images/screenshot.png index f807091..fa4661a 100644 Binary files a/images/screenshot.png and b/images/screenshot.png differ diff --git a/images/tags.png b/images/tags.png deleted file mode 100644 index 34f130a..0000000 Binary files a/images/tags.png and /dev/null differ diff --git a/images/tn.png b/images/tn.png index bfd6110..0fc1c0a 100644 Binary files a/images/tn.png and b/images/tn.png differ