From a1ce986ce0b6974fb4b995da9ff455577a0bd749 Mon Sep 17 00:00:00 2001 From: prototypa <54446028+prototypa@users.noreply.github.com> Date: Tue, 30 Aug 2022 12:48:42 -0400 Subject: [PATCH] Add Configuration section --- README.md | 40 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/README.md b/README.md index c553cc1..1b90087 100644 --- a/README.md +++ b/README.md @@ -114,6 +114,46 @@ All commands are run from the root of the project, from a terminal:
+### Configuration + +Basic configuration file: `./src/config.mjs` + +```javascript +export const SITE = { + name: "Example", + + domain: "https://example.com", + baseUrl: "/", // Change this if you need to deploy to Github Pages, for example + + title: "Example - This is the homepage title of Example", + description: "This is the homepage description of Example", + + googleAnalyticsId: false, // or "G-XXXXXXXXXX", + googleSiteVerificationId: false // or some value, +}; + +export const BLOG = { + disabled: false, + slug: "blog", // you can change this to "articles" (/articles) + + postsWithoutBlogSlug: true, // true (/some-slug), false (/blog/some-slug), + postsPerPage: 6, + + category: { + disabled: false, + slug: "category", // set empty to change from /category/some-slug to /some-slug + }, + + tag: { + disabled: false, + slug: "tag", + }, +}; + +``` + +
+ ### Deploy #### Deploy to production (manual)