Skip to content

Commit 847b2d8

Browse files
committed
Add Readme and screenshots
1 parent 70490c8 commit 847b2d8

File tree

4 files changed

+106
-0
lines changed

4 files changed

+106
-0
lines changed

README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Blist theme for Hugo
2+
3+
![Latest Release](https://img.shields.io/github/tag/apvarun/blist-hugo-theme.svg)
4+
![Blist hugo theme](https://img.shields.io/github/license/apvarun/blist-hugo-theme)
5+
![Hugo generator](https://img.shields.io/badge/generator-hugo-brightgreen)
6+
7+
Blist is a clean and fast blog theme for your Hugo site.
8+
9+
![Blist Icon](https://github.com/apvarun/blist-hugo-theme/raw/main/images/blist-logo.png)
10+
11+
**Features:**
12+
13+
- Responsive content
14+
- Blog pagination
15+
- Social links
16+
- Dark mode
17+
18+
## Preview
19+
20+
![Preview](https://github.com/apvarun/blist-hugo-theme/raw/main/images/screenshot.png)
21+
22+
➡️ [DEMO](https://blist.vercel.app/)
23+
24+
## Get the theme
25+
26+
Minimum Hugo Version: **0.69.0**
27+
28+
Run from the root of your Hugo site:
29+
30+
```sh
31+
git clone https://github.com/apvarun/blist-hugo-theme.git themes/blist
32+
```
33+
34+
Alternatively, you can include this repository as a [git submodule](https://git-scm.com/docs/gitsubmodules). This makes it easier to update this theme if you have your Hugo site in git as well:
35+
36+
```sh
37+
git submodule add https://github.com/apvarun/blist-hugo-theme.git themes/blist
38+
```
39+
40+
## Preview the theme
41+
42+
Blist theme ships with an fully configured example site. For a quick preview:
43+
44+
Copy the `package.json` file from `themes/showcase` folder to your hugo website root folder, and run `npm install`.
45+
46+
47+
```sh
48+
cd themes/blist/exampleSite/
49+
hugo serve --themesDir ../..
50+
```
51+
52+
Then visit `http://localhost:1313/` in your browser to view the example site.
53+
54+
When deploying to services like Netlify or Vercel, use the following command for building your site:
55+
56+
```sh
57+
npm i && hugo -D --gc
58+
```
59+
60+
## Add content
61+
62+
The following explains how to add content to your Hugo site. You can find sample content in the `exampleSite/` folder.
63+
64+
### Structure:
65+
66+
.
67+
├── ...
68+
├── blog # Blog Section
69+
│ ├── post1 # Post 1
70+
│ ├── post2 # Post 2
71+
│ └── _index
72+
└── ...
73+
74+
## Configure your site
75+
76+
From `exampleSite/`, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. Helpful comments are provided.
77+
78+
### Menu
79+
80+
Menu in Blist theme is pre-set to have all section names. You can include custom links in header using the `menu.main` option config.toml.
81+
82+
### Latex
83+
84+
Enable Mathematical options: set `math: true` in your markdown frontmatter
85+
86+
## Google Analytics
87+
88+
Set `googleAnalytics` in `config.toml` to activate Hugo's [internal Google Analytics template](https://gohugo.io/templates/internal/#google-analytics).
89+
90+
## Issues
91+
92+
If you have a question, please [open an issue](https://github.com/apvarun/blist-hugo-theme/issues) for help and to help those who come after you. The more information you can provide, the better!
93+
94+
## Contributing
95+
96+
Contributions, issues, and feature requests are welcome! For major changes, please open an issue first to discuss what you would like to change.
97+
98+
## License
99+
100+
Licensed under [MIT](LICENSE)
101+
102+
## 🤝 Support
103+
104+
Give a ⭐️ if you like this project!
105+
106+
<a href="https://www.buymeacoffee.com/apvarun" target="_blank" rel="noopener"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" height="40" width="145" alt="Buy Me A Coffee"></a>

images/blist-logo.png

72.5 KB
Loading

images/screenshot.png

872 KB
Loading

images/tn.png

373 KB
Loading

0 commit comments

Comments
 (0)