:pencil: Document subtitle on README.md, fix #3

1 files changed, 29 insertions, 24 deletions

diff --git a/README.md b/README.md
index 8ce999c..1f51425 100644
--- a/README.md
+++ b/README.md
@@ -60,12 +60,17 @@ the next section to configure your blog and add banner images on your pages.
           url: /about
     params:
       description: # The description of your site (used on a <meta> tag)
+      subtitleLength: 25 # The number of words on the subtitle of a page
     ```
 
     See <https://gohugo.io/getting-started/configuration/> for more configuration settings (such as `datetimeFormat`,
     `mainSections` or `paginate`).
     See also how to configure [post summaries](https://gohugo.io/content-management/summaries/) on the homepage.
 
+    Every page can have a subtitle, displayed bellow the title on the header of the page.
+    It's generated by default from the first `subtitleLength` words of the page's content.
+    It works the same as a [summary](https://gohugo.io/content-management/summaries/).
+
 2. Add banner images on your pages, you can either:
     - Add a `banner.jpg` image next to a `index.md` or `_index.md` page.
     - Add a `<page-filename>.jpg` image next to a `<page-filename>.md` page.
@@ -83,38 +88,38 @@ the next section to configure your blog and add banner images on your pages.
         banner: false
         ```
 
-    - For example, see the Blogpaper's [example site](https://github.com/NormandErwan/BlogpaperExampleSite):
-
-        ```bash
-        .
-        └── content
-            ├── posts
-            |   ├── rich-content
-            |   |   ├── banner.jpg
-            |   |   └── index.md # Use banner.jpg
-            |   ├── _index.md # No banner.jpg, use the parent banner: ../banner.jpg
-            |   ├── emoji-support.md # Use emoji-support.jpg
-            |   ├── emoji-support.jpg
-            |   └── ...
-            ├── _index.md # Use banner.jpg
-            ├── about.md # Use about.jpg
-            ├── about.jpg
-            └── banner.jpg
-        ```
-
-3. Edit the You can add a caption and link on a banner, add to the
-[front matter](https://gohugo.io/content-management/front-matter/) of your pages:
+    For example, see the Blogpaper's [example site](https://github.com/NormandErwan/BlogpaperExampleSite):
+
+      ```bash
+      .
+      └── content
+          ├── posts
+          |   ├── rich-content
+          |   |   ├── banner.jpg
+          |   |   └── index.md # Use banner.jpg
+          |   ├── _index.md # No banner.jpg, use the parent banner: ../banner.jpg
+          |   ├── emoji-support.md # Use emoji-support.jpg
+          |   ├── emoji-support.jpg
+          |   └── ...
+          ├── _index.md # Use banner.jpg
+          ├── about.md # Use about.jpg
+          ├── about.jpg
+          └── banner.jpg
+      ```
+
+    You can download free images on sites like [Lorem Picsum](https://picsum.photos/) or
+    [other](https://alternativeto.net/software/unsplash/).
+
+3. Add to the [front matter](https://gohugo.io/content-management/front-matter/) of your pages:
 
     ```yml
+    subtitle: # Optional, will be displayed bellow the title of the page; remove this line to generate an automatic subtitle
     banner:
       src: <banner-filename>.jpg # Optional, the filename of the banner, by default <page-filename>.jpg or banner.jpg
       caption: # Optional, the caption of the banner
       href: # Optional, a link on the caption
     ```
 
-You can download free images on sites like [Lorem Picsum](https://picsum.photos/) or
-[other](https://alternativeto.net/software/unsplash/).
-
 ## Troubleshooting / FAQ
 
 - I can't generate the site.