Enhanced port of the Ghost "ghostwriter" theme to the Hugo site generator, personalised from Juraj Bubniak's Ghostwriter theme.
Inside the folder of your Hugo site run:
$ mkdir themes
$ cd themes
$ git clone https://github.com/am1t/ghostwriter.gitFor more information read the official setup guide of Hugo.
After installing the theme you need to install javascript dependencies. You can use npm or yarn to install them from package.json. webpack is used to build and package the styles. In order to develop with realtime reloading of the style in the browser, the powerful commands can be used together.
hugo server
yarn run watchTo update theme styles edit the styles/style.scss file. You can then either use the watch command of yarn or npm or run build to compile the styles:
yarn run build- Support for Table of Contents (TOC) for pages and posts
- To use, just add
toc : trueto the post/page frontmatter - All the headers will be made available as hovering TOC
- To use, just add
- Support for link-posts. Just add the URL to be linked to via the title of the post in
refsparameter in frontmatter. - Enabled for IndieWeb
- Validate the compliance with tools at IndieWebify.me
- If WebMention endpoint (
webmentionEndpoint) is configured inSite.Paramssection ofconfig.toml, any mentions about the post across web should be pulled at the bottom of the page - If MicroPub endpoint (``micropubEndpoint) is configured in
Site.Paramssection of `config.toml`, new posts can be added to the site using MicroPub clients
- Option to credit the source of the image included in the post. Just add
imgsrcparameter pointing to the original source in the frontmatter - Minor improvements in styling across the board
You can use the following params to customize the theme. This file is also available in exampleSite directory.
baseurl = "https://example.com/"
title = "Ghostwriter example"
theme = "ghostwriter"
languageCode = "en-us"
copyright = "My Name"
disqusShortname = "XXX"
googleAnalytics = "XXX"
[Privacy]
[Privacy.disqus]
disable = true
[Privacy.googleAnalytics]
anonymizeIP = true
respectDoNotTrack = true
useSessionStorage = false
[Author]
name = "My Name"
profile = "https://google.com/+XXX"
email = "XXX@example.com"
nick = "my-name"
[Taxonomies]
tag = "tags"
[Params]
intro = true
headline = "Ghostwriter example"
description = "Ghostwriter example description"
github = "https://github.com/XXX"
gitlab = "https://gitlab.com/XXX"
linkedin = "https://linkedin.com/in/XXX/"
gplus = "https://google.com/+XXX"
twitter = "https://twitter.com/XXX"
stackoverflow = "https://stackoverflow.com/users/XXX/YYY"
microblog = "https://micro.blog/XXX"
feedurl = "http://example.com/index.xml"
webmentionEndpoint = "https://example.com/webmention"
pingbackEndpoint = "https://example.com/pingback"
micropubEndpoint = "https://example.com/webmention/micropub"
email = "XXX@example.com"
opengraph = true
shareTwitter = true
shareFacebook = true
shareGooglePlus = true
shareLinkedIn = false
dateFormat = "Mon, Jan 2, 2006"
highlightJsUrl = ""
highlightJsLocalUrl = ""
[Permalinks]
post = "/:year/:month/:day/:filename/"
[[menu.main]]
name = "Blog"
url = "/"
weight = 1
[[menu.main]]
name = "Projects"
url = "/project/"
weight = 2
[[menu.main]]
name = "Contact"
url = "/page/contact/"
weight = 3
[[menu.main]]
name = "About"
url = "/page/about/"
weight = 4You can also inject arbitrary HTML into <head> simply by overriding the extra-in-head.html partial, which is meant for that purpose.
The theme is enabled with IndieWeb support which can be validated via different tools at website IndieWebify.me.
