docs: normalize getting started config examples (#80)

This brings the getting started post closer to the configuration used
for the example site by using `feed` as the feed's basename.

Moreover, `enableRobotsTXT` was missing from the TOML configuration.
This commit is contained in:
Michael Kuhn 2021-08-02 11:02:43 +02:00 committed by GitHub
parent f867973ed6
commit 3e67c89bcc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -99,7 +99,7 @@ To prepare your new site environment just a few steps are required:
[outputFormats.Atom] [outputFormats.Atom]
name = "Atom" name = "Atom"
mediaType = "application/atom+xml" mediaType = "application/atom+xml"
baseName = "atom" baseName = "feed"
isPlainText = false isPlainText = false
rel = "alternate" rel = "alternate"
isHTML = false isHTML = false
@ -177,6 +177,9 @@ pygmentsCodeFences = true
disablePathToLower = true disablePathToLower = true
enableGitInfo = true enableGitInfo = true
# Required if you want to render robots.txt template
enableRobotsTXT = true
[markup] [markup]
[markup.goldmark.renderer] [markup.goldmark.renderer]
unsafe = true unsafe = true
@ -198,7 +201,7 @@ enableGitInfo = true
name = "Atom" name = "Atom"
mediaType = "application/atom+xml" mediaType = "application/atom+xml"
# generated file = <baseName>.<mediaType."application/atom+xml".suffixes[0]> = atom.xml # generated file = <baseName>.<mediaType."application/atom+xml".suffixes[0]> = atom.xml
baseName = "atom" baseName = "feed"
isPlainText = false isPlainText = false
rel = "alternate" rel = "alternate"
isHTML = false isHTML = false
@ -290,6 +293,9 @@ pygmentsCodeFences: true
disablePathToLower: true disablePathToLower: true
enableGitInfo: true enableGitInfo: true
# Required if you want to render robots.txt template
enableRobotsTXT: true
markup: markup:
goldmark: goldmark:
renderer: renderer:
@ -313,7 +319,7 @@ outputFormats:
name: "Atom" name: "Atom"
mediaType: "application/atom+xml" mediaType: "application/atom+xml"
# generated file: <baseName>.<mediaType."application/atom+xml".suffixes[0]> = atom.xml # generated file: <baseName>.<mediaType."application/atom+xml".suffixes[0]> = atom.xml
baseName: "atom" baseName: "feed"
isPlainText: false isPlainText: false
rel: "alternate" rel: "alternate"
isHTML: false isHTML: false
@ -334,9 +340,6 @@ outputs:
- HTML - HTML
- ATOM - ATOM
# Required if you want to render robots.txt template
enableRobotsTXT: true
params: params:
subtitle: "Blog about my favorite topics" subtitle: "Blog about my favorite topics"
description: "This is my personal blog about tech." description: "This is my personal blog about tech."