alyenc/lynx
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

📝 Update readme

Browse Source
This commit is contained in:
James Panther 2021-11-06 15:30:24 +11:00
parent 151c1acd3b
commit d4c0c33214
No known key found for this signature in database
GPG Key ID: D36F789E45745D17
2 changed files with 12 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -76,7 +76,7 @@ links = {
{ github = "https://github.com/jpanther/lynx" } { github = "https://github.com/jpanther/lynx" }
# Custom link # 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). 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`. 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: 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. 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 ## Contributing

10
exampleSite/content/readme.md
View File

@ -78,7 +78,7 @@ links = {
{ github = "https://github.com/jpanther/lynx" } { github = "https://github.com/jpanther/lynx" }
# Custom link # 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). 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`. 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: 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. 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 ## Contributing