hexo-theme-sb/README.md

Clean and simple theme for Hexo blog framework

# hexo-theme-sb

[Hexo Theme SB](https://sbtheme.silvestarbistrovic.from.hr) Clean and simple theme for Hexo blog framework.

Official website: [https://sbtheme.silvestarbistrovic.from.hr](https://sbtheme.silvestarbistrovic.from.hr)
Used on: [https://www.silvestarbistrovic.from.hr](https://www.silvestarbistrovic.from.hr)

## Installation

Npm installation:

```bash
npm i -S hexo-helper-inline-svg hexo-render-pug hexo-theme-sb
```

Yarn installation:

```bash
yarn add hexo-helper-inline-svg hexo-render-pug hexo-theme-sb
```

This will install SB theme in both `./node_modules/hexo-theme-sb/` and `./themes/hexo-theme-sb/`
folders.

## Initialization

Update the config file to start using SB theme:

```yml
theme: hexo-theme-sb
```

Check that your `.gitignore` file contains `/node_modules/` rule.

For better Hexo performance, you could add the following line to your config file:

```yaml
ignore:
  - '**/themes/**/*(node_modules|lib)' # improve performance while `hexo server` is running
```

## Configuration

There is already a config file in SB theme, but it is commented.
Here is the file with every possible option:

```yaml
# General section
site:
  full_name: SB - Silvestar's personal website
  short_name: SB
  description: Silvestar is a fearless web developer eager to prove his worth
  logo: /gfx/svg/logo.svg
  language: en

# Menu section
menu:
  centered: true
  display_logo: true
  items:
    Home: /
    Blog: /categories/articles
    Portfolio: /portfolio
    About: /about-me

# Homepage section
home_page:
  - section:
    title: Silvestar Bistrović
    paragraphs:
     - Fearless web developer
  - section:
    title: Specializations
    paragraphs:
      - Frontend
      - User Interface
      - Wordpress
      - Web Optimization
  - section:
    title: Projects
    links:
      Starter Project: //starter-project.silvestarbistrovic.from.hr
      Hexo Theme SB: //sbtheme.silvestarbistrovic.from.hr
      Contiamo: //www.contiamo.com
      Irina and Matej: //irinaandmatej.com
  - section:
    title: Links
    links:
      Mail: mailto:me@silvestarbistrovic.from.hr?Subject=Hello
      Twitter: //twitter.com/malimirkeccita
      Github: //github.com/maliMirkec

# Open Graph section
open_graph:
  pretty_url: true
  image: /gfx/jpg/SB-big.jpg
  fb:
    fb_id: 340933169673372
    fb_admins: malimirkeccita
  twitter:
    twitter_id: malimirkeccita
  google_plus:
    google_plus_id: +SilvestarbistrovicFromHr

# Widgets
widgets:
  contact:
    mail: mailto:me@silvestarbistrovic.from.hr?Subject=Hello
    twitter: //twitter.com/malimirkeccita
    linkedin: //www.linkedin.com/in/starbist/
    facebook: //www.facebook.com/silvestarbistrovic.from.hr/
    medium: //medium.com/@malimirkeccita
    github: //github.com/maliMirkec
    codepen: //codepen.io/CiTA/
    lastfm: //www.last.fm/user/maliMirkec
  google_analytics:
    tracking_id: UA-12345678-9
  disqus:
    shortname: silvestarbistrovic
  sharing:
    twitter: malimirkeccita
    facebook: silvestarbistrovic.from.hr
```


## Advanced

This theme follows the latest best practices. This is achieved by using [Starter Project].
Everything is already set up for you, but you could configure the theme by updating `./themes/hexo-theme-sb/config.json` file.

For example, if you want to generate new Critical CSS file, you should update `penthouse.criticalCssConfigs.url` option and set it according to your Hexo configuration.

After this, run `gulp` command inside `./themes/hexo-theme-sb/` folder.

__It is important that your website is running.__

## Support

If you need any help, please feel free to [contact me].

If you're having issues, please [search for issues](https://github.com/maliMirkec/hexo-theme-sb/issues) or open [a new one](https://github.com/maliMirkec/hexo-theme-sb/issues/new).

[Starter Project]: https://starter.silvestarbistrovic.from.hr
[contact me]: mailto:me@silvestarbistrovic.from.hr?Subject=Help