summaryrefslogtreecommitdiff
path: root/README.md
blob: c216cf9b266a2c906388f22b8e036aa61714e95b (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
53
54
# Tastefejl, a Hugo theme.

Tastefejl is a fork of the [Typo] Hugo theme, with the following changes:

* Replaced the JavaScript theme switching code with a CSS media query.

* Added VSCode syntax highlighting CSS (also the dark theme which Chroma doesn't include).
  You need to configure `markup.highlight.noClasses = false` in your `hugo.toml`.

* The home page embeds `content/home.md` rather than `homeIntroContent` from your `hugo.toml`
  because Markdown text should be in `.md` files.

* Removed the default favicon because no favicon is better than a favicon that has nothing to do with your website.

* Replaced the default footer saying *Powered by Hugo and tomfran/typo* with `<meta name=generator>` tags because nobody cares.

* Removed the render image hook that broke Markdown attributes for images (can be enabled with `markup.goldmark.parser.attribute.block = true`).

* Fixed blockquote styling (headings in blockquotes were touching the blockquote border).

* Removed the copy buttons for code blocks because they could obscure the code
  and also behaved wrongly on horizontal scrolling.

* Fixed that individual blog posts didn't have `rel=alternate` links. `homeCollection` is now also linked as the RSS feed of the home page.
  Tip: Hugo by default also generates an RSS entry for the home page disable this in `hugo.toml` with:

  ```toml
  [outputs]
  home = ['html']
  section = ['html']
  taxonomy = ['html']
  term = ['html']
  ```

  And then reenable this in `content/posts/_index.md` for posts with:

  ```
  +++
  title = "Posts"
  outputs = ["HTML", "RSS"]
  +++
  ```

* Removed [Simple Icons] because I don't want to plaster brands on my website and at one point a 50MB .html file was committed
  (I filtered the git history to reduce the size of the repository.)

[Typo]: https://github.com/tomfran/typo
[Simple Icons]: https://simpleicons.org/

## Wiki

The [Wiki](./wiki/) is the place to find instructions on how to [setup](./wiki/setup.md) the theme and an overview of the available [features](./wiki/features).

Some of the most relevant are: heading auto-numbering, dark mode, color palettes, dark and light images, comments, etc.