/bay

Simple and tropic Hugo theme

Primary LanguageSCSSMIT LicenseMIT

bay

Version

Bay is a simple theme for Hugo. Live Demo

The Bay Hugo theme is a port of the Bay Jekyll theme by Eliott Vincent.

screenshot of a webpage with the bay theme installed

Installation

  1. Clone this repo: git clone https://github.com/skowalak/bay
  2. Install Hugo (get it here)
  3. Create a new directory for your new site: mkdir my_new_site && cd my_new_site/
  4. An example website is included in the exampleSite directory. For usage info see below. Copy the contents of exampleSite to your new directory: cp ~/Downloads/bay/exampleSite/* .
  5. Copy the bay directory to the themes directory: cp ~/Downloads/bay/ themes/
  6. Run the Hugo development server hugo server -D

For more information on Hugo visit the documentation.

Example Site

An Example Site is included in the exampleSite directory.

The logo on the website header is an image under static/img/title.png. To use text instead, set the logo.image parameter to false and set the logo.text parameter to the text you want to be displayed:

params:
  logo:
    image: true
    text: BAY THEME

You can add links to the website header by modifying the params section in config.yaml. Note: do not add slashes to the beginning of the slugs.

params:
  menu:
    - name: Home
      slug: 
    - name: Work
      slug: work
    - name: Blog
      slug: blog
    - name: Personal
      slug: posts/personal

To add Social Media links or contact links to the footer:

params:
  contact:
    - name: Email
      value: yourmail@domain.com
      link: mailto:yourmail@domain.com
  social:
    - name: Twitter
      link: http://twitter.com/YourTwitterUsername

Icons can be placed in themes/bay/static/img/icons. They must be a lower-case version of the name. Some platforms use links from your website to your profile with a special rel attribute. To add such an attribute, use the rel parameter:

params:
  social:
    - name: Mastodon
      link: https://mastodon.social/YourMastodonUsername
      rel: me

To modify the home page, edit the content/index.md file, to add more blog posts add more files to content/blog/, to add more sections to the work page, add more files to content/work/.

Have fun!