1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
# <a href="https://vickylai.com/call-me-sam/" target="_blank" rel="noopener">Call me Sam: a theme for Hugo</a>
Sam is a Simple and Minimalist theme for Hugo. It lets you categorize and showcase your content the way you want to.
Focused on content and typography, the stylized index page is really just a list of navigation links that you can set in your `config.toml`. This versatile design is limited only by your imagination, as you can make it say anything you like. Here are some ideas.
Features:
- Showcase content
- Content-focused page templates for list pages, single pages, and posts
- A responsive CSS grid gallery page that renders from a folder of images
- Customize
- Custom navigation menu set via `config.toml`
- Custom footer text
- Developer-approved
- Syntax highlighting
- Share-ready metadata set via `config.toml` (OpenGraph and Twitter Cards integration)
- Easy-to-navigate pug and Sass files included
## Quick start
### 1. Get the theme
From the root of your Hugo site:
```sh
$ cd themes
$ git clone https://github.com/vickylai/hugo-theme-sam.git sam
```
### 2. Configure your site
From the exampleSite, copy `config.toml` to the root folder of your Hugo site and change the fields as you like. There are helpful hints in the file.
### 3. Create pages
Run:
```sh
$ hugo new page.md
```
Where `page` can be anything you like. A contact page, a bio, dates for your upcoming world tour... Anything!
### 4. Design your main menu and index page
In `config.toml`, customize the entries for `[[params.mainMenu]]` however you like. You can have as many or as few entries as you like. You can even include external links.
This list comprises the index page and part of the navigation menu at the bottom of single content pages. Here's an example:
```
[[params.mainMenu]]
link = "/photography"
text = "photography"
[[params.mainMenu]]
link = "/posts"
text = "writing"
[[params.mainMenu]]
link = "/about"
text = "who dis?"
```
## Preview your site locally
Use Hugo's built-in server to see your site in action as you make changes.
```
$ hugo serve -t sam
```
Visit `localhost:1313` in your browser to see a live preview of your site.
## Posts
To create a new post, run:
```
$ hugo new posts/your-post-title.md
```
## Editing the theme
All the theme's `pug` and `sass` files are included. You can compile these to HTML and CSS respectively using the npm scripts included in `package.json`.
Prerequisites:
* Node.js and npm: https://www.npmjs.com/get-npm
To install all dependencies:
```
$ npm install
```
Available commands are:
* `npm run build:pug` compiles pug files to HTML
* `npm run build:sass` compiles Sass files to compressed CSS
* `npm run autoprefixer` autoprefixes the compiled CSS
* `npm run build` does all the above
* `npm watch` watches Sass files for changes and automatically recompiles and autoprefixes the CSS
## Contributing
Pull requests for bug fixes and enhancements are welcome.
__Thank you to:__ @paskal, @crownsedge, @jazzi, @hakamadare, and @mfg92!
## License
Copyright (C) 2018 Vicky Lai
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
|
