Configuration

Parameters

The following is a list of parameters used by Etch.

Name	Type	Description	Example
description	string	Description of the site.	"This is a description"
copyright	string	Copyright placed at bottom of each page.	"Copyright © 2020 Your Name"
dark	string	Dark mode setting. Choose from auto (default), on, or off (more info).	"auto"
highlight	boolean	Enables import of CSS highlight stylesheet if true (more info).	true

Menu Configuration

See Navigation.

Permalink Configuration

Etch recommends removing the subdirectory for posts in URLs, turning example.com/posts/some-post.md into example.com/some-post.md. This is done by editing the path for the posts section. See https://gohugo.io/content-management/urls/ for more info.

Name	Type	Description	Example
posts	string	Updates the URL used to access content added to the posts folder. Removes the posts/ subdirectory, meaning posts can be accessed at example.com/some-post.md instead of example.com/posts/some-post.md. The name should match the folder in content you store posts in.	"/:title/"

Sample Configuration

The sample configuration used in the example site is a good starting point. It is reproduced below.

baseURL = "https://example.com"
title = "Website Name"
theme = "etch"
languageCode = "en-US"
enableInlineShortcodes = true
pygmentsCodeFences = true
pygmentsUseClasses = true

[params]
  description = "Your site description"
  copyright = "Copyright © 2020 Your Name"
  dark = "auto"
  highlight = true

[menu]
  [[menu.main]]
    identifier = "posts"
    name = "posts"
    title = "posts"
    url = "/"
    weight = 10

  [[menu.main]]
    identifier = "about"
    name = "about"
    title = "about"
    url = "/about/"
    weight = 20

[permalinks]
  posts = "/:title/"

[markup.goldmark.renderer]
  # Allows HTML in Markdown
  unsafe = true