diff --git a/README.md b/README.md index 706cddd..338329b 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,33 @@ # pulp -![logo](https://user-images.githubusercontent.com/17229643/45928032-f0658a80-bf77-11e8-91a0-00a267e75c6e.png) -Pulp is a theme of Hugo framework for realize simple and readable personal blogs. +![logo](https://rawcdn.githack.com/koirand/pulp/5484f16d91e42c7796de8adc29b15c01eb782370/images/logo.png) + +Pulp is a [Hugo](https://gohugo.io/) theme for getting a simple, easy-to-read blog site. ## Screenshots -![screenshot-top](https://github.com/koirand/pulp/blob/master/images/ss-top.png) -![screenshot-list](https://github.com/koirand/pulp/blob/master/images/ss-list.png) -![screenshot-page](https://github.com/koirand/pulp/blob/master/images/ss-page.png) +![screenshot-top](https://rawcdn.githack.com/koirand/pulp/5484f16d91e42c7796de8adc29b15c01eb782370/images/ss-top.png) -## Install and Use theme -1. Inside the folder of your Hugo site run: +![screenshot-list](https://rawcdn.githack.com/koirand/pulp/5484f16d91e42c7796de8adc29b15c01eb782370/images/ss-list.png) + +![screenshot-page](https://rawcdn.githack.com/koirand/pulp/5484f16d91e42c7796de8adc29b15c01eb782370/images/ss-page.png) + +## Installation + +If your site is also under version control using git, the easiest way to install this theme is to add it as a submodule. If you have not created a git repo for your project yet, you need to run `git init` beforehand. Inside the folder of your Hugo site, run the following command. ``` -cd themes -git submodule add https://github.com/koirand/pulp.git pulp +git submodule add https://github.com/koirand/pulp.git themes/pulp ``` -2. Configure your config.toml with reference to exampleSite. -3. Build your site with `hugo server`. +Alternatively, you can clone the theme into your project. -For more information, read the official [guide](https://gohugo.io/themes/installing-and-using-themes/) of Hugo. +``` +git clone https://github.com/koirand/pulp.git themes/pulp +``` + +## Configuration + +Configure your config.toml with reference to exampleSite. +Put your own avatar image in /static/images/avatar.jpg of your own site, and also favicon.ico. Hugo will automatically use that imgaes instead of the standard one. It's not necessary to alter the theme. ## Update the theme You can update the theme by issuing the following command inside your project folder. @@ -26,3 +35,5 @@ You can update the theme by issuing the following command inside your project fo ``` git submodule update --remote --rebase ``` + +If you have cloned the theme, you can run `git pull` inside the theme folder. diff --git a/exampleSite/config.toml b/exampleSite/config.toml index bda2eb5..3cbbccb 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -3,8 +3,8 @@ title = "Site Title" theme = "pulp" canonifyurls = true hasCJKLanguage = true -pygmentsCodefences = false -pygmentsUseClasses = false +# pygmentsCodefences = true +# pygmentsUseClasses = true # googleAnalytics = "{your tracking code}" [params] @@ -15,8 +15,8 @@ pygmentsUseClasses = false Please write anything here. Profiles, backgrounds, favorite things etc. """ - publicationYear = "2018" - listPageDateFormat = "January, 2006" # See https://gohugo.io/functions/format/ + publicationYear = "2019" + listPageDateFormat = "January, 2006" # See https://gohugo.io/functions/format/ singlePageDateFormat = "January 2, 2006" # custom_css = ["/css/custom.css"] # custom_js = ["/js/custom.js"] @@ -26,7 +26,7 @@ pygmentsUseClasses = false [[menu.main]] name = "Blog" - pre = "" + pre = "" #Choose your favorite font from Font Awesome url = "/blog/" weight = 10 diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 0000000..244ae08 Binary files /dev/null and b/images/logo.png differ diff --git a/theme.toml b/theme.toml index a02d802..0ae55b1 100644 --- a/theme.toml +++ b/theme.toml @@ -4,13 +4,10 @@ name = "pulp" license = "MIT" licenselink = "https://github.com/koirand/pulp/blob/master/LICENSE" -description = "Pulp is theme of Hugo framework for realize simple and readable blog." -homepage = "https://github.com/koirand/pulp/" -tags = ["minimal", "blog", "simple", "light", "personal"] -features = ["blog", "themes"] +description = "Pulp is a Hugo theme for getting a simple, easy-to-read blog site." +tags = ["minimal", "blog", "simple", "light", "personal", "search"] min_version = "0.41" [author] name = "koirand" homepage = "https://koirand.github.io" -