From d66ef1c4bb053c171e70b5c6435b1005a437f71b Mon Sep 17 00:00:00 2001 From: Thilo Hohlt <123883702+thiloho@users.noreply.github.com> Date: Sun, 28 May 2023 17:08:24 +0200 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index 8f8f639..f466fdf 100644 --- a/README.md +++ b/README.md @@ -24,3 +24,40 @@ I wrote a simple algorithm for the search, and the matching works well. You can ### Theme toggle There are three websites themes: Light, Dark and System (inherits the theme of your browser or operating system). + +## Make the theme yours + +Replace the domain specified for the `site` property in the `astro.config.ts` file with your own domain: + +```json +site: "https://aurora.thilohohlt.com" +``` + +Change the `title` and `description` props in `index.astro` to match your website: + +```html + +``` + +In the components `Head.astro` and `Footer.astro`, replace *Your Name* with your actual name: + +```html + +``` + +```html +Copyright © {currentDateYear} Your Name
Astro aurora theme +``` + +The about section on the main page can be modified by adjusting the markdown text in the file `src/content/about/about.md`: + +```md +## About + +aurora is a minimal blog theme built with Astro, Svelte and plain CSS. It is focused on accessibility and usability. +... +``` + +The cover image (the image people see embedded when you send a link to your website) can be changed by altering the file `public/cover.jpg`. + +Blog articles are created using Astro content collections, images for individual blog posts are stored in `/src/assets/blog-post-name/image-name.jpg`. You can take a look at the example blog posts in this repository to see how it all works out.