• Stars
    star
    1
  • Language
    CSS
  • License
    MIT License
  • Created about 5 years ago
  • Updated about 5 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

PHP Hugo Theme

PHP Pages theme powered by Hugo.

Installation

You can install the theme either as a clone or submodule.

I recommend the latter. From the root of your Hugo site, type the following:

$ git submodule add https://github.com/brzuchal/php-hugo-theme.git themes/php
$ git submodule init
$ git submodule update

Now you can get updates to PHP Theme in the future by updating the submodule:

$ git submodule update --remote themes/php

Configuration

After installation, take a look at the exampleSite folder inside themes/php.

To get started, copy the config.toml file inside exampleSite to the root of your Hugo site:

$ cp themes/php/exampleSite/config.toml .

Now edit this file and add your own information. Note that some fields can be omitted.

I recommend you use the theme's archetypes so now delete your site's archetypes/default.md.

Syntax highlighting

The theme supports syntax highlighting thanks to highlight.js.

It's disabled by default, so you have to enable it by setting highlight to true in your config.

You can change the style used for the highlighting by using the highlightStyle field.

Only the "common" languages will be loaded by default. To load more, use highlightLanguages.

A list of all the available styles and languages can be found here.

Please note the style and languages should be written in hyphen-separated lowercase, for example:

[params]
    highlight = true
    highlightStyle = "solarized-dark"
    highlightLanguages = ["php"]