Update config.yaml section in README.md

This commit is contained in:
widgeter
2023-07-29 14:49:23 -04:00
committed by GitHub
parent d77c7924d4
commit 6a29c83083

View File

@ -149,32 +149,32 @@ Basic configuration file: `./src/config.yaml`
```yaml ```yaml
site: site:
name: AstroWind name: 'Example'
site: 'https://astrowind.vercel.app' site: 'https://example.com'
base: '/' # Change this if you need to deploy to Github Pages, for example base: '/' # Change this if you need to deploy to Github Pages, for example
trailingSlash: false # Generate permalinks with or without "/" at the end trailingSlash: false # Generate permalinks with or without "/" at the end
googleSiteVerificationId: orcPxI47GSa-cRvY11tUe6iGg2IO_RPvnA1q95iEM3M googleSiteVerificationId: false // Or some value,
# Default SEO metadata # Default SEO metadata
metadata: metadata:
title: title:
default: AstroWind default: 'Example'
template: '%s — AstroWind' template: '%s — Example'
description: "\U0001F680 Suitable for Startups, Small Business, Sass Websites, Professional Portfolios, Marketing Websites, Landing Pages & Blogs." description: 'This is the default meta description of Example website'
robots: robots:
index: true index: true
follow: true follow: true
openGraph: openGraph:
siteName: AstroWind siteName: 'Example'
images: images:
- url: '~/assets/images/default.jpg' - url: '~/assets/images/default.jpg'
width: 1200 width: 1200
height: 628 height: 628
type: website type: website
twitter: twitter:
handle: '@onwidget' handle: '@twitter_user'
site: '@onwidget' site: '@twitter_user'
cardType: summary_large_image cardType: summary_large_image
i18n: i18n:
@ -188,7 +188,7 @@ apps:
post: post:
isEnabled: true isEnabled: true
permalink: '/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category% permalink: '/blog/%slug%' # Variables: %slug%, %year%, %month%, %day%, %hour%, %minute%, %second%, %category%
robots: robots:
index: true index: true