rayelliott
/
hugo-coder-fork
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README.md (#31) 

* Update README.md

* Added documentation
This commit is contained in:
Niels Reijn 2018-06-06 00:28:00 +02:00 committed by Luiz F. A. de Prá
parent ec35c0ef93
commit 4016deb430
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -21,18 +21,32 @@ git clone https://github.com/luizdepra/hugo-coder.git themes/coder
Add the following lines to your `config.toml`. Add the following lines to your `config.toml`.
```toml ```toml
theme = "coder" # set the theme baseurl = "http://www.example.com" # Hostname (and path) to the root.
title = "johndoe" # Site title.
theme = "coder" # Set the theme.
languagecode = "en" # The site’s language code.
paginate = 20 # Default number of pages per page in pagination.
canonifyurls = true # Enable to turn relative URLs into absolute.
pygmentsstyle = "b2" # Color-theme or style for syntax highlighting.
pygmentscodefencesguesssyntax = true # Enable syntax guessing for code fences without specified language.
[params] # theme parameters [params] # theme parameters
author = "John Doe" # author's name author = "John Doe" # Author's name.
info = "Full Stack DevOps and Magician" # author's job title or info info = "Full Stack DevOps and Magician" # Author's job title or info.
description = "John Doe's personal website" # site description description = "John Doe's personal website" # Site description.
keywords = "blog,developer,personal" # site keywords keywords = "blog,developer,personal" # Site keywords.
# wether you want to hide copyright and credits in the footer disqusShortname = "yourdiscussshortname" # Enable or disable Disqus
# Wether you want to hide copyright and credits in the footer.
hideCredits = false hideCredits = false
hideCopyright = false hideCopyright = false
# Custom CSS
custom_css = []
# Social links # Social links
[[params.social]] [[params.social]]
name = "Github" name = "Github"
@ -112,6 +126,7 @@ Coder is licensed under the [MIT license](https://github.com/luizdepra/hugo-code
- [Ralf Junghanns](https://github.com/rabbl) - [Ralf Junghanns](https://github.com/rabbl)
- [tobaloidee](https://github.com/Tobaloidee) - [tobaloidee](https://github.com/Tobaloidee)
- [Vlad Ionescu](https://github.com/Vlaaaaaaad) - [Vlad Ionescu](https://github.com/Vlaaaaaaad)
- [Niels Reijn](https://github.com/reijnn)
## Special Thanks ## Special Thanks