hugo-theme-readable

Fork of https://github.com/cjtheham/hugo-theme-readable
git clone https://git.eamoncaddigan.net/hugo-theme-readable.git
Log | Files | Refs | README | LICENSE

configuration.md (1030B)


      1 # Configuration
      2 
      3 ## Theme parameters
      4 
      5 The following settings can go either directly into a separate `params.yml` file or into a section `params` in your `config.yml`, e.g.
      6 
      7 ```yaml
      8 theme: 'readable'
      9 title: 'Your Title'
     10 [...]
     11 params:
     12     theme_parameter: value
     13 ```
     14 
     15 ### author
     16 
     17 Your name.
     18 
     19 ```yaml
     20 author: Your name goes here
     21 ```
     22 
     23 ### mastodon
     24 
     25 The link to your Mastodon profile.
     26 
     27 ```yaml
     28 mastodon: https://mastodon.example/@profile
     29 ```
     30 
     31 ### subtitle
     32 
     33 The subtitle for your page.
     34 
     35 ```yaml
     36 subtitle: This is the subtitle of the website.
     37 ```
     38 
     39 ### navbar_style
     40 
     41 This selects the look of the navigation bar at the top of the page. See the [readable.css wiki](https://codeberg.org/Freedom-to-Write/readable.css/wiki/Navbar-Styles) for possible styles.
     42 
     43 > Attention!!!  
     44 > readable.css changed it's default navbar style from 'classy' to 'default' with v1.1.0.  
     45 > This theme however chose to keep 'classy' as the default style, so the look of existing websites wouldn't change suddenly after an update.
     46 
     47 ```yaml
     48 navbar_style: classy
     49 ```