website-theme/README.md

39 lines
1.6 KiB
Markdown
Raw Normal View History

2018-09-23 07:11:35 -04:00
# pulp
2019-03-29 12:28:56 -04:00
![logo](https://user-images.githubusercontent.com/17229643/55247565-50245180-528b-11e9-9947-aa3c54ea05bb.png)
2019-03-28 13:53:05 -04:00
Pulp is a [Hugo](https://gohugo.io/) theme for getting a simple, easy-to-read blog site.
2018-09-23 07:11:35 -04:00
2018-09-23 08:06:02 -04:00
## Screenshots
2019-03-29 12:28:56 -04:00
![screenshot-top](https://user-images.githubusercontent.com/17229643/55247370-c7a5b100-528a-11e9-835b-108bd6047699.png)
2019-03-28 13:53:05 -04:00
2019-03-29 12:28:56 -04:00
![screenshot-list](https://user-images.githubusercontent.com/17229643/55247387-d12f1900-528a-11e9-8144-c984031e16c0.png)
2018-09-23 08:06:02 -04:00
2019-03-29 12:28:56 -04:00
![screenshot-page](https://user-images.githubusercontent.com/17229643/55247395-d5f3cd00-528a-11e9-82ed-4830523c5bfa.png)
2019-03-28 13:53:05 -04:00
## Installation
If your site is also under version control using git, the easiest way to install this theme is to add it as a submodule. If you have not created a git repo for your project yet, you need to run `git init` beforehand. Inside the folder of your Hugo site, run the following command.
2018-09-23 08:06:02 -04:00
```
2019-03-28 13:53:05 -04:00
git submodule add https://github.com/koirand/pulp.git themes/pulp
2018-09-23 08:06:02 -04:00
```
2019-03-28 13:53:05 -04:00
Alternatively, you can clone the theme into your project.
2018-09-23 08:06:02 -04:00
2019-03-28 13:53:05 -04:00
```
git clone https://github.com/koirand/pulp.git themes/pulp
```
## Configuration
Configure your config.toml with reference to exampleSite.
2019-05-10 14:16:16 -04:00
Put your own avatar image in /static/img/avatar.jpg of your own site, and also favicon.ico. Hugo will automatically use that images instead of the standard one. It's not necessary to alter the theme.
2018-09-23 08:06:02 -04:00
## Update the theme
You can update the theme by issuing the following command inside your project folder.
2018-09-23 08:06:02 -04:00
```
git submodule update --remote --rebase
```
2019-03-28 13:53:05 -04:00
If you have cloned the theme, you can run `git pull` inside the theme folder.