diff options
author | st-wong <shintatt.wong@gmail.com> | 2019-09-13 05:10:49 +0300 |
---|---|---|
committer | st-wong <shintatt.wong@gmail.com> | 2019-09-13 05:10:49 +0300 |
commit | 1723e452764199ef51d3edf2bddf3540875c36a5 (patch) | |
tree | 6a556cd0b3c1e9f5278682c6528ef6fa84c15e64 /README.md | |
parent | 599fe408a73e25c2f3640ad1d3f8fb5284f73a9e (diff) |
Update README with more accurate details and, Single post template with tags display & back button (instead of home). Removed config.sample.toml.
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 41 |
1 files changed, 20 insertions, 21 deletions
@@ -1,11 +1,11 @@ # Spectre Pixel Theme - + This theme was inspired by [Cactus Theme](https://github.com/digitalcraftsman/hugo-cactus-theme) but I wanted a timeline for my portfolio and found something I could use from [SPECTRE.CSS](https://picturepan2.github.io/spectre/). I also changed most of the initial theme design to be something more similar to the [Material Design](https://material.io/design/introduction/#principles). 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 +# Using the theme + 1. [Install Hugo](https://gohugo.io/overview/installing/) 2. Create a new site (replace `MySite` with your site's name) ```bash @@ -15,7 +15,7 @@ cd MySite More info at [Hugo docs](https://gohugo.io/getting-started/quick-start/) 3. Clone this repository ```bash -git clone --recursive https://github.com/st-wong/hugo-spectre-pixel-theme themes/spectre-pixel +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](#configuration). @@ -24,35 +24,34 @@ vim config.toml ``` 5. Test site (please make sure you're in the `MySite` folder) ```bash -hugo server -t material-timeline +hugo server -t spectre-pixel ``` 6. Enjoy! - -# Configuration -1. config.toml -There's a sample config (`config.sample.toml`) in the `exampleSite` folder, fill in your details and display texts as you please. -Remember to copy the file to your `MySite` folder once you're done putting in the details, also make sure the filename is saved as `config.toml`. -2. About page +# 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](http://konpa.github.io/devicon/) using the provided shortcode `{{< tag javascript >}`. +It can contain your skillsets with [Devicons](http://konpa.github.io/devicon/) 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 +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](https://lospec.com/palette-list) 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 +## Contributing + Found a bug or got an idea for a new feature? Feel free to use the [issue tracker](//github.com/st-wong/hugo-spectre-pixel-theme/issues) to let me know. Or directly make a [pull request](//github.com/st-wong/hugo-spectre-pixel-theme/pulls). Please create a separate branch for your pull request. - -## License +## License + This theme is released under the MIT license. For more information read the [license](//github.com/st-wong/hugo-spectre-pixel-theme/blob/master/LICENSE.md). - - -## Acknowledgements +## Acknowledgements + [Credits](//github.com/st-wong/hugo-spectre-pixel-theme/blob/master/CREDITS.md) - |