✨ Add ability to override link parameters

README.md

@@ -47,7 +47,7 @@ Below is a quick start guide using Hugo modules.
 
 4. In the root folder of your website, replace the `config.toml` file that was generated by Hugo with the one from Lynx. You will find the theme config file in the Hugo cache directory, or [download a copy](https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/jpanther/lynx/tree/stable/config.toml) from GitHub.
 
-5. Edit the settings in the `config.toml` file to suit your needs. You can also create a `content/_index.md` file to add additional text to your site.
+5. Follow the [configuration instructions](#configuration) below.
 
 ### Installing theme updates
 
@@ -55,6 +55,35 @@ As new releases are posted, you can update the theme using Hugo. Simply run `hug
 
 ---
 
+## Configuration
+
+The main theme configuration is managed in the `config.toml` file. Most parameters are self explanatory and the default config contains some basic examples.
+
+The author name and image are displayed at the top of the page. Both are optional and will default to the site title with no image when not provided.
+
+Links can either be a simple string containing the URL for the link, or an object that defines the link parameters. Links are displayed in the order provided in the config file.
+
+Acceptable link parameters are:
+
+- `href` = the URL the link should point to
+- `icon` = the name of the icon to use for this link (optional)
+- `text` = the link text (optional)
+
+```toml
+[author]
+links = {
+   # Simple link
+   { github = { href = "https://github.com/jpanther/lynx", text = "Visit my website" }}
+
+   # Custom link
+   { link = { href = "https://github.com/jpanther/lynx", text = "GitHub Project", icon = "github" }}
+}
+```
+
+Additional page content can be provided by creating a Markdown file at `content/_index.md`. The contents of this file will be displayed between the title and links. Check out the exampleSite to see this in practice.
+
+---
+
 ## Contributing
 
 Lynx is expected to evolve over time. I intend to keep adding features and making changes as required.