Skip to content

Commit 4db982b

Browse files
committed
Initial files
0 parents  commit 4db982b

35 files changed

+2525
-0
lines changed

.editorconfig

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# http://editorconfig.org
2+
3+
# this file is the top-most editorconfig file
4+
root = true
5+
6+
# all files
7+
[*]
8+
charset = utf-8
9+
end_of_line = lf
10+
indent_style = space
11+
indent_size = 4
12+
insert_final_newline = true
13+
trim_trailing_whitespace = true
14+
15+
# markdown files
16+
[*.md]
17+
insert_final_newline = false
18+
trim_trailing_whitespace = false
19+
20+
# configuration files
21+
[*.toml]
22+
indent_size = 2
23+
24+
# web files
25+
[*.{html,css,less}]
26+
indent_size = 2

LICENSE.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
The MIT License (MIT)
2+
3+
Copyright (c) 2018 Luiz F. A. de Prá
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in
7+
the Software without restriction, including without limitation the rights to
8+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9+
the Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
# hugo-coder
2+
3+
A simple and clean blog theme for Hugo.
4+
5+
![](https://github.com/luizdepra/hugo-coder/blob/master/images/screenshot.png)
6+
7+
## How to use this theme
8+
9+
To use `hugo-coder` go through the following steps.
10+
11+
### Download
12+
13+
Clone this repository into your Hugo project.
14+
15+
```
16+
git clone https://github.com/luizdepra/hugo-coder.git themes/coder
17+
```
18+
19+
### Configuration
20+
21+
Add the following lines to your `config.toml`.
22+
23+
```toml
24+
theme = "coder" # set the theme
25+
26+
[permalinks] # configure post and fixed pages permalinks
27+
post = "posts/:title/"
28+
default = ":title/"
29+
30+
[params] # theme parameters
31+
author = "John Doe" # author's name
32+
info = "Full Stack DevOps and Magician" # author's job title or info
33+
description = "John Doe's personal website" # site description
34+
keywords = "blog,developer,personal" # site keywords
35+
36+
# Social links
37+
[[params.social]]
38+
name = "Github"
39+
weight = 1
40+
url = "https://github.com/johndoe/"
41+
[[params.social]]
42+
name = "Twitter"
43+
weight = 2
44+
url = "https://twitter.com/johndoe/"
45+
[[params.social]]
46+
name = "LinkedIn"
47+
weight = 3
48+
url = "https://www.linkedin.com/in/johndoe/"
49+
50+
# Menu links
51+
[[menu.main]]
52+
name = "Blog"
53+
weight = 1
54+
url = "/posts/"
55+
[[menu.main]]
56+
name = "About"
57+
weight = 2
58+
url = "/about/"
59+
```
60+
61+
You can look at full working [`config.toml`](https://github.com/luizdepra/hugo-coder/blob/master/exampleSite/config.toml) inside the [exampleSite](https://github.com/luizdepra/hugo-coder/tree/master/exampleSite) folder.
62+
63+
### Build & Test
64+
65+
To build your site and test, run:
66+
67+
```
68+
hugo server
69+
```
70+
71+
## To Do
72+
73+
- GoogleAnalytics integration
74+
- Comments (probably not Disqus, sorry)
75+
- Tags, Categories and Series
76+
77+
## License
78+
79+
Coder is licensed under the [MIT license](https://github.com/luizdepra/hugo-coder/blob/master/LICENSE.md).
80+
81+
## Author
82+
83+
[Luiz de Prá](https://luizdepra.com)
84+
85+
## Special Thanks
86+
87+
- Gleen McComb, for his great [article](https://glennmccomb.com/articles/how-to-build-custom-hugo-pagination/) about custom pagination.

archetypes/default.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+++
2+
draft = true
3+
title = ""
4+
slug = ""
5+
+++

archetypes/post.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
+++
2+
draft = true
3+
date = "2018-01-01T00:00:00-00:00"
4+
title = ""
5+
slug = ""
6+
tags = []
7+
categories = []
8+
+++

exampleSite/config.toml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
baseurl = "//johndoe.com/"
2+
title = "johndoe"
3+
4+
theme = "coder"
5+
6+
languagecode = "en"
7+
8+
paginate = 20
9+
canonifyurls = true
10+
11+
pygmentsstyle = "b2"
12+
pygmentscodefences = true
13+
pygmentscodefencesguesssyntax = true
14+
15+
[permalinks]
16+
post = "posts/:title/"
17+
default = ":title/"
18+
19+
[params]
20+
author = "John Doe"
21+
description = "John Doe's personal website"
22+
keywords = "blog,developer,personal"
23+
info = "Full Stack DevOps and Magician"
24+
25+
[[params.social]]
26+
name = "Github"
27+
weight = 1
28+
url = "https://github.com/johndoe/"
29+
[[params.social]]
30+
name = "Twitter"
31+
weight = 2
32+
url = "https://twitter.com/johndoe/"
33+
[[params.social]]
34+
name = "LinkedIn"
35+
weight = 3
36+
url = "https://www.linkedin.com/in/johndoe/"
37+
38+
[[menu.main]]
39+
name = "Blog"
40+
weight = 1
41+
url = "/posts/"
42+
[[menu.main]]
43+
name = "About"
44+
weight = 2
45+
url = "/about/"

exampleSite/content/about.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
+++
2+
title = "About Hugo"
3+
slug = "about"
4+
+++
5+
6+
Hugo is a static site engine written in Go.
7+
8+
9+
It makes use of a variety of open source projects including:
10+
11+
* [Cobra](https://github.com/spf13/cobra)
12+
* [Viper](https://github.com/spf13/viper)
13+
* [J Walter Weatherman](https://github.com/spf13/jWalterWeatherman)
14+
* [Cast](https://github.com/spf13/cast)
15+
16+
Learn more and contribute on [GitHub](https://github.com/spf13).
17+
18+
## Setup
19+
20+
Some fun facts about [Hugo](http://gohugo.io/):
21+
22+
* Built in [Go](http://golang.org/)
23+
* Loosely inspired by [Jekyll](http://jekyllrb.com/)
24+
* Primarily developed by [spf13](http://spf13.com/) on the train while commuting to and from Manhattan.
25+
* Coded in [Vim](http://vim.org) using [spf13-vim](http://vim.spf13.com/)
26+
27+
Have questions or suggestions? Feel free to [open an issue on GitHub](https://github.com/spf13/hugo/issues/new) or [ask me on Twitter](https://twitter.com/spf13).
28+
29+
Thanks for reading!

0 commit comments

Comments
 (0)