search

st-wong / hugo-spectre-pixel-theme

MIT License
16 stars 9 forks source link

readme

Spectre Pixel Theme

This theme was inspired by Cactus Theme but I wanted a timeline for my portfolio and found something I could use from SPECTRE.CSS. I also changed most of the initial theme design to be something more similar to the Material Design. The pixel style switch was something I just did for fun to represent my passion in the game industry, and since I don't see much themes with a theme switch, I thought it'll be good to leave it for others to use.

Using the theme

  1. Install Hugo
  2. Create a new site (replace MySite with your site's name). More info at Hugo docs 
    hugo new site MySite
cd MySite
  3. Clone this repository 
    git clone --recursive https://github.com/st-wong/hugo-spectre-pixel-theme.git themes/spectre-pixel
  4. Configure Use your favourite editor to configure config.toml. More details in Configuration. 
    vim config.toml
  5. Test site (please make sure you're in the MySite folder) 
    hugo server -t spectre-pixel
  6. Enjoy!

Configuration

  1. config.toml
    There's a config (config.toml) in the exampleSite folder which you can use, just change the details and display texts to suit your needs. Remember to copy the file to your MySite folder once you're done editing the details.
  2. About page
    Edit the _index.md file in the exampleSite/content/about folder to give more details about yourself. It can contain your skillsets with Devicons using the provided shortcode {{< tag javascript >}}. However, the shortcode generates links to tags which need to exist in your posts' tags or a 404 page will be displayed.
  3. Styling
    Edit the style.css file in the static/css folder to change the fonts & colors as you please. You can use color palettes from LOSPEC for the pixel theme. Finally, please make sure the url("../images/avatar.png") & url("../images/pixel.png") are pointing to absolute URLs instead. E.g. https://YOUR_DOMAIN_NAME.com/images/avatar.png & https://YOUR_DOMAIN_NAME/images/pixel.png

Contributing

Found a bug or got an idea for a new feature? Feel free to use the issue tracker to let me know. Or directly make a pull request. Please create a separate branch for your pull request.

License

This theme is released under the MIT license. For more information read the license.

Acknowledgements

Credits