tvl-depot/users/wpcarro/website/blog/themes/tailwind/readme.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

63 lines
1.9 KiB
Markdown
Raw Normal View History

2019-11-19 19:36:13 +01:00
# TailwindCSS Journal
_TailwindCSS Journal_ is a minimalist theme for [Hugo](https://gohugo.io) using [TailwindCSS](https://tailwindcss.com).
Based on [Journal](https://dashdashzako.github.io/hugo-journal-demo/), it also focuses on improving reading experience with no fancy effect.
It uses [Chroma](https://gohugo.io/content-management/syntax-highlighting/) for the syntaxic coloration of code snippets.
2019-11-19 19:48:41 +01:00
Demo is available [here](https://ianrodrigues.github.io/hugo-tailwind-journal-demo/).
2019-11-19 19:36:13 +01:00
## Installation
Please refer to the [Hugo documentation](https://gohugo.io/themes/installing/).
## Configuration
A few parameters should be adjusted in the site config:
```toml
baseURL = "https://username.github.io/"
disqusShortname = "username"
googleAnalytics = "UA-XXXXXXXXX-X"
title = "Tailwind Journal"
theme = "hugo-tailwind-journal"
pygmentsCodeFences = true
pygmentsUseClasses = true
[taxonomies]
tag = "tags"
[permalinks]
posts = "/posts/:year/:month/:title/"
[params]
author = "John Doe"
avatar = "images/avatar.jpg"
description = "A minimalist journal template for Hugo using TailwindCSS."
tagline = "A minimalist journal template for Hugo using TailwindCSS."
[languages]
[languages.en]
contentDir = "content/english"
languageCode = "en-us"
languageName = "🇺🇸 English"
weight = 1
[languages.pt-br]
contentDir = "content/portuguese"
description = "Um template minimalista para Hugo usando TailwindCSS."
languageCode = "pt-br"
languageName = "🇧🇷 Português"
tagline = "Um template minimalista para Hugo usando TailwindCSS."
weight = 2
[languages.de]
contentDir = "content/german"
description = "Eine minimalistische Journalvorlage für Hugo mit TailwindCSS."
languageCode = "de"
languageName = "🇩🇪 Deutsch"
tagline = "Eine minimalistische Journalvorlage für Hugo mit TailwindCSS."
weight = 3
```