https://github.com/jbub/ghostwriter

A port of ghostwriter theme to Hugo.
https://github.com/jbub/ghostwriter

hugo hugo-theme

Last synced: 2 months ago
JSON representation

A port of ghostwriter theme to Hugo.

• Host: GitHub
• URL: https://github.com/jbub/ghostwriter
• Owner: jbub
• License: mit
• Fork: true (roryg/ghostwriter)
• Created: 2015-04-26T09:57:24.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-02-21T10:03:37.000Z (10 months ago)
• Last Synced: 2024-08-08T18:23:26.719Z (4 months ago)
• Topics: hugo, hugo-theme
• Language: SCSS
• Homepage:
• Size: 1.68 MB
• Stars: 177
• Watchers: 8
• Forks: 153
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - jbub/ghostwriter - A port of ghostwriter theme to Hugo. (others)

README

        
# Ghostwriter

Enhanced port of the Ghost "[ghostwriter](https://github.com/roryg/ghostwriter)" theme to the [Hugo](https://gohugo.io) site generator.

## Installation

Inside the folder of your Hugo site run:

```bash

$ mkdir themes

$ cd themes

$ git clone https://github.com/jbub/ghostwriter

```

For more information read the official [setup guide](//gohugo.io/overview/installing/) of Hugo.

## Development

After installing the theme you need to install javascript dependencies. You can use 

`npm` to install them from `package.json`. We are using `webpack` to build and package 

styles. In order to develop with realtime reloading in the browser you can use this powerful combo:

```bash

hugo server

npm run watch

```

To update theme styles edit the `styles/style.scss` file. You can then either use the `watch` command

or run `build` to compile the styles:

```bash

npm run build

```

## Example config.yml

To customize your theme you can use following params:

```yaml

baseurl: "https://example.com/"

title: mytitle

theme: ghostwriter

languageCode: en-us

copyright: My Name

googleAnalytics: XXX

disqusShortname: XXX

pygmentsUseClasses: true

pygmentsCodefences: true

markup:

  highlight:

    codeFences: true

    guessSyntax: false

    hl_Lines: ""

    lineNoStart: 1

    lineNos: false

    lineNumbersInTable: true

    noClasses: true

    tabWidth: 2

privacy:

  disqus:

    disable: true

  googleAnalytics:

    anonymizeIP: true

    respectDoNotTrack: true

    useSessionStorage: false

author:

  name: My Name

  profile: ""

taxonomies:

  tag: tags

params:

  mainSections:

    - post

  intro: true

  headline: My headline

  description: My description

  github: "https://github.com/XXX"

  gitlab: "https://gitlab.com/XXX"

  linkedin: "https://linkedin.com/in/XXX/"

  twitter: "https://twitter.com/XXX"

  stackoverflow: "https://stackoverflow.com/users/XXX/YYY"

  facebook: "https://www.facebook.com/username"

  email: [email protected]

  opengraph: true

  shareTwitter: true

  rss: true

  shareFacebook: true

  shareLinkedIn: false

  dateFormat: "Mon, Jan 2, 2006"

  exponeaJsUrl: ""

  exponeaTarget: ""

  exponeaToken: ""

  exponeaTrackVisits: false

  readingTime: true

  readingTimeText: "Estimated reading time:"

  fathomUrl: ""

  fathomSiteId: ""

  plausibleAnalytics:

    domain: ""

    # Default value is plausible.io, overwrite this if you are self-hosting or using a custom domain

    serverURL: ""

permalinks:

  post: "/:year/:month/:day/:filename/"

menu:

  main:

    - name: Blog

      url: /

      weight: 1

    - name: Projects

      url: /project/

      weight: 2

    - name: Contact

      url: /page/contact/

      weight: 3

    - name: About

      url: /page/about/

      weight: 4

```

You can also inject arbitrary HTML into `` simply by overriding the `extra-in-head.html`

partial, which is meant for that purpose.