Skip to content

Getting Started

WayJam So edited this page Jan 18, 2021 · 6 revisions

Welcome to the hugo-theme-fluency wiki!

Installation & Update

Install with Git Submodule:

git submodule add https://github.com/wayjam/hugo-theme-fluency.git themes/fluency

Next, add theme: fluency in config.yml. After completing the above steps, use the following command to preview the project in the browser: hugo server

To update with:

git submodule update --rebase --remote

Configuration

1. Highlight

Enable highlight as below.

pygmentsUseClasses: true # enable theme-defined highlight style
pygmentsCodefences: true

2. Menus

More info about hugo menus, please refer to Hugo - Menus.

Navbar Menu
menu:
  main:
    - identifier: posts
      name: posts
      url: posts/
      weight: 1
    - identifier: tags
      name: tags
      url: tags/
      weight: 2
    - identifier: archives
      name: archives
      url: archives/
      weight: 3
    - identifier: about
      name: about
      url: about/
      weight: 4  # order by asc
Footer Menu
menu:
  footer:
    - identifier: twitter
      url: "https://twitter.com/gohugoio"
      name: Twitter
    - identifier: github
      url: "https://github.com/gohugoio"
      name: Github

3. Pagination

You can set different page size for every layouts.

params:
  pageSize:
    index: 5
    list: 10
    terms: 60
    archives: 20

4. Copyright

params:
  copyright: "© 2021 <a href='https://github.com/wayjam/hugo-theme-fluency'>Hugo Theme Fluency</a>."

HTML string is allowed.

5. Main Sections

Main sections will list at index page. Section name will be shown before every post date when mainSections is greater than one.

params:
  mainSections:
    - posts
    - pics

6. MathJax

Just add params.enableMathJax: true to config, then mathjax.js(provided by Mathjx.org) will load from cdn in regular page.

7. Comment

If you want to use Disqus as commenting service, just add disqusShortname: your-name to config.

Comment will be hidden when disableComment is true. And if you just wanna some type of content hide comments, disableCommentByType

FAQ

Clone this wiki locally