planblog/README.md

75 lines
2.0 KiB
Markdown
Raw Permalink Normal View History

# planblog
2015-02-03 13:41:01 +00:00
## Overview
planblog is a simple and clean blog theme for [Hugo](http://gohugo.io/).
2015-02-03 13:41:01 +00:00
Notable features are:
- Simple and clean design
- Client side source code highlighting
2015-07-17 15:12:39 +00:00
- Social links (Twitter, Facebook, GitHub, LinkedIn, Instagram, Keybase)
2015-02-03 13:41:01 +00:00
- Support for tags
2015-02-03 15:56:38 +00:00
- Analytics with Google Analytics or Mixpanel
2015-02-03 13:41:01 +00:00
- Responsive design
- Font Awesome icons
## Installation
In your hugo site directory, run:
2015-02-03 15:41:34 +00:00
```shell
2015-02-03 13:41:01 +00:00
$ mkdir themes
$ cd themes
$ git clone https://git.plantroon.com/plantroon/planblog.git
2015-02-03 13:41:01 +00:00
```
planblog is also included in the `spf13/hugoThemes` repository.
2015-07-17 15:12:39 +00:00
2015-02-03 13:41:01 +00:00
## Configuration
You may specify following options in `config.toml` of your site to make use of
2015-02-03 15:56:38 +00:00
this theme's features.
2015-02-03 13:41:01 +00:00
2015-02-03 15:41:34 +00:00
```toml
2015-02-03 13:41:01 +00:00
baseurl = "Your site URL"
languageCode = "en-us"
title = "Your site title"
# Copyright notice. This is displayer in the footer.
copyright = "© Copyright notice"
[params]
# Social accounts. Link to these accounts are displayed in the header and
2015-02-23 13:10:41 +00:00
# footer.
2015-02-03 13:41:01 +00:00
twitter = "Your Twitter username"
github = "Your GitHub username"
linkedin = "Your LinkedIn username"
googleplus = "Your Google+ user id"
2015-02-03 13:41:01 +00:00
facebook = "Your Facebook username"
stackoverflow = "Your Stackoverflow user id (number)"
2015-06-29 20:36:28 +00:00
keybase = "Your keybase.io username"
instagram = "Your Instagram username"
2015-07-17 15:20:39 +00:00
# Disqus shortname
disqus = "Your disqus shortname"
2015-02-23 13:10:41 +00:00
# Google Analytics API key.
2015-02-03 15:56:38 +00:00
ga_api_key = "Your Google Analytics tracking id"
2015-02-23 13:10:41 +00:00
# Mixpanel API key.
2015-02-03 13:41:01 +00:00
mixpanel_api_key = "Your Mixpanel API key"
2015-02-23 13:10:41 +00:00
author = "Your Name"
avatar = "/path/to/avatar"
contact = "Your contact link (ex. mailto:foo@example.com)"
2015-07-17 15:12:39 +00:00
bio = "Your short bio"
2015-02-23 13:10:41 +00:00
# Short subtitle/tagline. This is displayed in the header.
2015-07-17 15:12:39 +00:00
subtitle = "Short subtitle/tagline of your blog"
themecolor = "#hexcolor" # Defines the tab color in Chrome for Android.
2015-02-03 13:41:01 +00:00
```
## Usage
Use hugo's `-t planblog` or `--theme=planblog` option with hugo commands.
2015-02-03 13:41:01 +00:00
Example:
2015-02-03 15:41:34 +00:00
```shell
$ hugo server -t planblog -w -D
2015-02-03 13:41:01 +00:00
```