blob: 1318b9cccceb4964b1151aa652a2e4d40d87872c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
|
# 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/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 = "damiencaselli"
twitterUsername = "damiencaselli"
tagline = "Blog tagline. Shown under index title."
[params.work]
jobTitle = "some"
company = "Inria"
companyUrl = "https://www.inria.fr/"
[params.gpg]
key = "0xF788CE68916E6C39"
fingerprint = "9C29 20E7 2B07 E195 4E38 52E4 F788 CE68 916E 6C39"
link = "https://pgp.mit.edu/pks/lookup?op=get&search=0xF788CE68916E6C39"
```
### 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`.
### Update 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 themes/journal/scss/journal.scss themes/journal/static/css/journal.css
```
|
