An open API service indexing awesome lists of open source software.

https://github.com/navdevl/calloutmyname

Coming Soon.
https://github.com/navdevl/calloutmyname

Last synced: about 2 months ago
JSON representation

Coming Soon.

Awesome Lists containing this project

README

          

# Journal

_Journal_ is a minimalist theme for [Hugo](http://gohugo.io).

It focuses on improving reading experience with high contrast colors and no fancy effect.

It also uses [Highlight.js](https://highlightjs.org/) for the syntaxic coloration of code snippets.

Demo is available [here](https://damiencaselli.github.io/hugo-journal-demo/).

## Installation

Please refer to the [Hugo documentation](http://gohugo.io/themes/installing/).

## Configuration

A few parameters should be adjusted in the site config:

```toml
[params]
description = "Blog meta description."
githubUsername = "your_gh_username"
twitterUsername = "your_twitter_handle"
tagline = "Blog tagline. Shown under index title."
[params.work]
jobTitle = "occupation"
company = "the company"
companyUrl = "https://the.company.url/"
[params.gpg]
key = "0x1111111111111111"
fingerprint = "0000 0000 0000 0000 0000 0000 0000 0000 0000 0000"
link = "https://pgp.mit.edu/pks/lookup?op=get&search=0x1111111111111111"
```

### Code highlighting

Both highlight theme and lib can be overridden. Just drop your build in the `static/js` directory, and the theme file in the `static/css` directory.
Note that the theme has to be named `highlight.css`.

### Customize styles

sass is required to build the theme css file. If [bundler](http://bundler.io/) is installed on your system:

```bash
bundle install

# test your changes
scss-lint scss/journal.scss

# build stylesheet
sass --scss --sourcemap=none scss/journal.scss static/css/journal.css
```