From ebc81c0a5bc7b888f46ab706c920ed94c7cd4f37 Mon Sep 17 00:00:00 2001
From: Alexander Bilz <mail@alexbilz.com>
Date: Tue, 25 May 2021 20:50:27 +0000
Subject: [PATCH] Merge pull request #210 from alexanderdavide/feature/add-favicon-files-info-to-docs

---
 README.md |   84 +++++++++++++++++++++++++++++-------------
 1 files changed, 58 insertions(+), 26 deletions(-)

diff --git a/README.md b/README.md
index 68b0678..6777884 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
 
 ## Features
 
-Anatole's aims to be minimalistic and sleek, but still brings some great functionality.
+Anatole's aims to be minimalistic and sleek but still brings some great functionality.
 
 ### Features include
 
@@ -70,9 +70,11 @@
 description = "Call me Jane"
 profilePicture = "images/profile.jpg"
 ```
+
 Please note that the title under the `[params]` only adjusts the page title in the sidebar. If you wish to adjust the HTML title (i.e. name of the tab), you will have to adjust the Hugo's title variable, as shown in the `config.toml`.
 
 Please note that the slogan can be multi-lined (note the three quotes at the beginning and end):
+
 ```toml
 [params]
 description = """
@@ -81,13 +83,19 @@
 """
 ```
 
-
 ### Favicon
 
-Add your own favicon in `static/favicons/favicon.ico`.
+Add your favicons to `static/favicons`. Anatole currently employs following favicon files:
+
+- `favicon.ico`
+- `favicon-16x16.png`
+- `favicon-32x32.png`
+- `apple-touch-icon.png` (resolution should be 180x180)
 
 ### Copyright
-By default, the copyright will show the authors name followed by the current year, but you can change this by configuring the `copyright` parameter.  If this method is used, the string `{{ YEAR }}` will be replaced with the current year during site generation.
+
+By default, the copyright will show the authors name followed by the current year, but you can change this by configuring the `copyright` parameter. If this method is used, the string `{{ YEAR }}` will be replaced with the current year during site generation.
+
 ```toml
 copyright = "2020-{{ YEAR }}"
 ```
@@ -130,21 +138,27 @@
 ```
 
 ### Disable Theme Switcher
+
 You can easily disable the theme switcher from the `config.toml`. All you have to do is to set the parameter `disableThemeSwitcher` to `true`.
+
 ```toml
 [params]
 disableThemeSwitcher = true # Theme switcher is enabled by default
 ```
 
 ### Disable Animations
+
 You can easily disable the animations from the `config.toml`. All you have to do is to set the parameter `doNotLoadAnimations` to `true`.
+
 ```toml
 [params]
 doNotLoadAnimations = true # Animations are loaded by default
 ```
 
 ### Control the date Format
+
 You can change the default date formating for the `list.html`, the `single.html` and the `index.html`. Simply configure the matching parameters.
+
 ```toml
 [params]
 singleDateFormat = "Mon, Jan 2, 2006"
@@ -153,28 +167,36 @@
 ```
 
 ### Changing the sidebar/content ratio
+
 By default, the content fills up 60% of the screen width on devices with a full HD resolution. If you want to change the ratio, adjust the `contentratio` variable. Let's, for example, set the content ratio to 70%:
+
 ```toml
 [params]
 contentratio = 0.7
 ```
 
 ### Read-more Links
+
 You can enable read-more links for truncated posts by setting the `readMore = true`. The length of the preview is controlled by Hugo's `summarylength`. Read-more links are disabled by default.
+
 ```toml
 [params]
   readMore = true
 ```
 
 ### Have a static page as a home page
+
 If you prefer having a static page as your home page rather than a listing of the latest posts, then make sure you leave the `mainSections` parameter blank:
+
 ```toml
 [params]
   mainSections = []
 ```
+
 Put any content into the `_index.md` file located in the content directory. If you want, you can also have some static text and the posts below. In such case, simply keep the `mainSections = ["post"]` and put any static content in the `_index.md`.
 
 ### Rename post section
+
 If you want to have a different post section identifier, such as `/blog`, you can specify the section name using `postSectionName`:
 
 ```toml
@@ -185,7 +207,9 @@
 If the parameter is not set, it will default to `post`. Be sure to check the name of the folder containing your post files and change it accordingly in order for links to reflect the new post section name.
 
 ### Show full post content on the home page
+
 If you prefer the full content of your posts to appear on the home page rather than a summary of each post, then set the parameter `fullPostContent` to `true`.
+
 ```toml
 [params]
 fullPostContent = true
@@ -193,7 +217,7 @@
 
 ### Multilingual support
 
-Anatole supports multilingual page setups. All you need to do is to add the languages to your 'config.toml'. For each language you can set the custom options like title or description. It's important to include a `LanguageName`, as it will be displayed in the main menu.
+Anatole supports multilingual page setups. All you need to do is to add the languages to your 'config.toml'. For each language, you can set the custom options like title or description. It's important to include a `LanguageName`, as it will be displayed in the main menu.
 
 ```toml
 [Languages]
@@ -209,7 +233,7 @@
   LanguageName = "DE"
 ```
 
-There are two ways of translating your content either by adding a suffix in the filename eg. `mypost.de.md` or by setting a contentDir (a certain directory) for each language. [Link to the Hugo documentation](https://gohugo.io/content-management/multilingual/). If you want to use the option with the `contentDir`, you will have to add the `contentDir` parameter for each language:
+There are two ways of translating your content, either by adding a suffix in the filename, eg. `mypost.de.md`, or by setting a contentDir (a certain directory) for each language. [Link to the Hugo documentation](https://gohugo.io/content-management/multilingual/). If you want to use the option with the `contentDir`, you will have to add the `contentDir` parameter for each language:
 
 ```toml
 [languages]
@@ -243,15 +267,14 @@
 
 Anatole currently ships with support for some basic languages. Contributions for other language translations are welcome.
 
-### RTL suppourt 
+### RTL support
 
-Anatole support RTL langauges and flip the whole theme for that. To enable the RTL mode for specific langauge it's enough to write the following code in the language params.
+Anatole supports RTL languages and flip the whole theme for that. To enable the RTL-mode for a specific language, it's enough to write the following code in the language params.
 
 ```toml
-LanguageDirection = "rtl" 
+LanguageDirection = "rtl"
 ```
 
-
 ### :100: Google Lighthouse score
 
 The theme is optimized to adhere to the requirements checked for in the Lighthouse Audit. On my [personal site](https://www.alexbilz.com) I was able to reach a perfect 100⁄100 score.
@@ -274,14 +297,16 @@
 repo = "githubuser/reponame"
 issueTerm = "pathname"
 theme= "preferred-color-scheme"
-# label = 
+# label =
 ```
 
 Two notes on the security of Utteranc.es
-- If you are using a strict CSP, you'll have to add the domain to it. 
-- The script currently has no built-in integrity check, due to limitations of [Utterances](https://github.com/utterance/utterances/issues/40).
+
+- If you are using a strict CSP, you'll have to add the domain to it.
+- The script currently has no built-in integrity check due to limitations of [Utterances](https://github.com/utterance/utterances/issues/40).
 
 ### Comments powered by Commento
+
 You can use [Commento](https://commento.io/) as an alternative to Disqus. All you need to do is to configure a `CommentoURL`:
 
 ```toml
@@ -293,7 +318,6 @@
 
 Comments can be disabled per page by setting `disableComments: true` on the pages [Front Matter](https://gohugo.io/content-management/front-matter/)
 
-
 ### Google Analytics
 
 To use Google Analytics, a valid tracking code has to be added. If you don't want to load the code, then commend out the parameter.
@@ -302,7 +326,7 @@
 googleAnalytics = "UA-123-45"
 ```
 
-To use the modern Google Analytics 4, include the following under `[params]` replacing the id with your own.
+To use the modern Google Analytics 4, include the following under `[params]`, replacing the id with your own.
 
 ```toml
 [params]
@@ -338,13 +362,18 @@
 enable = false  # options: true, false. Enable math support globally, default: false. You can always enable math on per page.
 use = "katex"  # options: "katex", "mathjax". default is "katex".
 ```
+
 ### Formspree Contact Form on the Contact page
+
 Step 1: Configure the `contactFormAction` in the `config.toml`
+
 ```toml
 [params]
 #contactFormAction = "https://formspree.io/f/your-form-hash-here"
 ```
-Step 2: Activate the `contact: true` or  `contact=true` in the frontmatter of a page. See `exampleSite/content/contact.html` as an example.
+
+Step 2: Activate the `contact: true` or `contact=true` in the frontmatter of a page. See `exampleSite/content/contact.html` as an example.
+
 ### Twitter Cards support
 
 In order to use the full functionality of Twitter cards, you will have to define a couple of settings in the `config.toml` and the frontmatter of a page.
@@ -361,21 +390,25 @@
 ```toml
 images = ["post-cover.png"]
 ```
+
 ### Open Graph Support
 
 The [internal template for Open Graph protocol](https://gohugo.io/templates/internal/#open-graph) uses a mix of configuration variables; settings in `config.toml` and frontmatter of the page. In a nutshell, you will have to configure a taxonomies series.
 
 ### Post Thumbnails
+
 Thumbnails can be enabled easily by setting the `thumbnail` parameter in the frontmatter of a post to an image such as `"images/landscape.jpg"`.
+
 ```md
 +++
 ...
 tags = [
-    "thumbnail",
+"thumbnail",
 ]
 thumbnail= "images/landscape.jpg"
 +++
 ```
+
 Make sure to put the image in the `static/images/` directory.
 
 ### Custom CSS
@@ -405,7 +438,7 @@
 customJs = ["js/hello.js", "js/world.js"]
 ```
 
-On the user-side it will look like this:
+On the user-side, it will look like this:
 
 ```text
 .
@@ -417,7 +450,7 @@
 
 `hello.js` and `world.js` will be bundled into a `custom.min.js`.
 
-You can also include links to remote javascript files (hosted on CDNs for example). But be aware, that integrity settings and minification won't be applied. Further make sure to adjust your CSP. You can load a remote script like this:
+You can also include links to remote javascript files (hosted on CDNs for example). But be aware that integrity settings and minification won't be applied. Further, make sure to adjust your CSP. You can load a remote script like this:
 
 ```toml
 [params]
@@ -442,7 +475,7 @@
 
 ### Content Security Policy
 
-The theme is compliant with most strict CSP policies out of the box. A sample CSP for an Anatole-based site would look something like this:
+The theme is compliant with the most strict CSP policies out of the box. A sample CSP for an Anatole-based site would look something like this:
 
 ```text
 Content-Security-Policy "
@@ -482,7 +515,7 @@
 
 ### Robots.txt
 
-If you want Hugo to generate a robots.txt, you will have to set the `enableRobotsTXT` in the `config.toml` to `true`. By default a robots.txt, which allows search engine crawlers to access to any page, will be generated. It will look like this:
+If you want Hugo to generate a robots.txt, you will have to set the `enableRobotsTXT` in the `config.toml` to `true`. By default, a robots.txt, which allows search engine crawlers to access to any page, will be generated. It will look like this:
 
 ```text
 User-agent: *
@@ -492,7 +525,7 @@
 
 ### Syntax highlighting
 
-This theme has support for either Hugo's lightning-fast Chroma code highlighting. See the [Hugo docs](https://gohugo.io/content-management/syntax-highlighting/) for more information.
+This theme has support for Hugo's lightning-fast Chroma code highlighting. See the [Hugo docs](https://gohugo.io/content-management/syntax-highlighting/) for more information.
 
 To enable Chroma, add the following to your site parameters:
 
@@ -525,7 +558,7 @@
 
 Ordering in the `config.toml` will determine the display order on the webpage.
 
-#### Example branded social entry
+#### Sample branded social entry
 
 ```toml
 [[params.socialIcons]]
@@ -534,7 +567,7 @@
 url = "https://de.linkedin.com/"
 ```
 
-#### Example standard social entry
+#### Sample standard social entry
 
 ```toml
 [[params.socialIcons]]
@@ -572,7 +605,7 @@
 
 ## Maintenance
 
-This theme is maintained by its author [Alexander Bilz](https://github.com/lxndrblz) and with the help from these awesome [contributors](https://github.com/lxndrblz/anatole/graphs/contributors). Please open an issue/pull request if you want to contribute to making this theme better and more feature-complete. For PRs please make sure that they align with theme's goals: minimalism, speed and elegance.  
+This theme is maintained by its author [Alexander Bilz](https://github.com/lxndrblz) and with the help from these awesome [contributors](https://github.com/lxndrblz/anatole/graphs/contributors). Please open an issue/pull request if you want to contribute to making this theme better and more feature-complete. For PRs, please make sure that they align with the theme's goals: minimalism, speed and elegance.
 
 ## Sponsoring
 
@@ -580,7 +613,6 @@
 
 [![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/lxndrblz/)
 
-
 ## Special Thanks 🎁
 
 - Go to [Cai Cai](https://github.com/hi-caicai), for the great Anatole Farbox theme that formed the foundation for this theme.

--
Gitblit v1.10.0