From d4c0c33214c46097e9f05d2c7888d9839cc7efe3 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Sat, 6 Nov 2021 15:30:24 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20readme?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 10 ++++++---- exampleSite/content/readme.md | 10 ++++++---- 2 files changed, 12 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 42ddc7a..7eacee7 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ links = { { github = "https://github.com/jpanther/lynx" } # Custom link - { link = { href = "https://github.com/jpanther/lynx", text = "GitHub Project", icon = "github" }} + { github = { href = "https://github.com/jpanther/lynx", text = "GitHub Project" } } } ``` @@ -92,7 +92,11 @@ The custom CSS file will automatically be included and minified when the site is If you need icons, you can find free SVG icons for many services at [FontAwesome](https://fontawesome.com/icons?d=gallery&p=2&s=brands). -As an example, to make a custom link for FontAwesome... +#### Example + +Let's make a custom link for FontAwesome using the FA flag as the link icon and a gradient background as the link style. + +> If you prefer to inspect the code, the exampleSite contains a custom link to FontAwesome that demonstrates this process. 1. Place the SVG icon in the icons folder `/assets/icons/font-awesome.svg`. 2. Create the CSS file at `/assets/css/custom.css` and add in a rule to style the link: @@ -119,8 +123,6 @@ As an example, to make a custom link for FontAwesome... When the site is rebuilt, the new custom link will appear. -> If you prefer to inspect the code, the exampleSite contains a custom link to FontAwesome that demonstrates this process. - --- ## Contributing diff --git a/exampleSite/content/readme.md b/exampleSite/content/readme.md index 1f688fd..f45d0c0 100644 --- a/exampleSite/content/readme.md +++ b/exampleSite/content/readme.md @@ -78,7 +78,7 @@ links = { { github = "https://github.com/jpanther/lynx" } # Custom link - { link = { href = "https://github.com/jpanther/lynx", text = "GitHub Project", icon = "github" }} + { github = { href = "https://github.com/jpanther/lynx", text = "GitHub Project" } } } ``` @@ -94,7 +94,11 @@ The custom CSS file will automatically be included and minified when the site is If you need icons, you can find free SVG icons for many services at [FontAwesome](https://fontawesome.com/icons?d=gallery&p=2&s=brands). -As an example, to make a custom link for FontAwesome... +#### Example + +Let's make a custom link for FontAwesome using the FA flag as the link icon and a gradient background as the link style. + +> If you prefer to inspect the code, the exampleSite contains a custom link to FontAwesome that demonstrates this process. 1. Place the SVG icon in the icons folder `/assets/icons/font-awesome.svg`. 2. Create the CSS file at `/assets/css/custom.css` and add in a rule to style the link: @@ -121,8 +125,6 @@ As an example, to make a custom link for FontAwesome... When the site is rebuilt, the new custom link will appear. -> If you prefer to inspect the code, the exampleSite contains a custom link to FontAwesome that demonstrates this process. - --- ## Contributing