diff options
author | Parsiya <that_is_not_my_email@email.email> | 2016-02-02 10:09:48 +0300 |
---|---|---|
committer | Parsiya <that_is_not_my_email@email.email> | 2016-02-02 10:09:48 +0300 |
commit | 75e703b305da95bac3fa925a878ac52a5a2e3fb1 (patch) | |
tree | adb0d5b4b29a2ed0ddb27e31da78e408b4a8042f | |
parent | 46886e775451f254b3a3f1478106dcf490a3a190 (diff) |
added sample config file
-rw-r--r-- | README.md | 8 | ||||
-rw-r--r-- | sample-config.toml | 94 |
2 files changed, 96 insertions, 6 deletions
@@ -20,7 +20,7 @@ Hugo-Octopress is a port of the classic [Octopress][octopress-link] theme to [Hu ## <a name="config"></a>Configuration -This section talks about parameters in the [configuration file](https://gohugo.io/overview/configuration/) and how they can be used to customize the output. Below is a sample ``config.toml`` file with comments: +This section talks about parameters in the [configuration file](https://gohugo.io/overview/configuration/) and how they can be used to customize the output. A working config file `sample-config.toml`is provided and below is a sample ``config.toml`` with comments: ``` python baseurl = "http://example.com/" @@ -234,10 +234,6 @@ If you see any issues/bugs or you are looking for some features please use the G If you know how to clean it up, please let me know or better yet help me do it :) -**Clean up the theme** from my own website's data. - -**Update `theme.toml`** after code is uploaded to github with repo info and other items. - ## <a name="attribution"></a>Attribution * [Octopress](octopress-link) is created by [Brandon Mathis](https://github.com/imathis). Octopress source can be found on [https://github.com/imathis/octopress](https://github.com/imathis/octopress). @@ -252,7 +248,7 @@ Ported by Parsia Hakimian: * twitter: [@CryptoGangsta](https://twitter.com/cryptogangsta) ## <a name="themelicense"></a>Theme license -Open sourced under the MIT license [link to MIT license in the repo after upload]. +Open sourced under the [MIT license](https://github.com/parsiya/Hugo-Octopress/blob/master/LICENSE.md). [octopress-link]: http://octopress.org diff --git a/sample-config.toml b/sample-config.toml new file mode 100644 index 0000000..a0e31f0 --- /dev/null +++ b/sample-config.toml @@ -0,0 +1,94 @@ +baseurl = "http://example.com" +disablePathToLower = true +languageCode = "en-us" +title = "Parsia's Den" +theme = "hugo-octopress" + +# number of blog posts displayed in each page +paginate = 6 + +pygmentsuseclasses = false +pygmentsstyle = "solarized_dark" + +# you need to install Solarized from https://github.com/john2x/solarized-pygment.git +# Octopress blog used Solarized_dark +# options are solarized_dark (octopress), solarized_dark256 and default (solarized light) + +# will make the highlight shortcode and ``` do the same thing - otherwise they are treated differently and we do not want that +pygmentscodefences = true + +# can pass in pygments options here, it can also be added in the highlight shortcode +# pygmentsoptions = "linenos=true" + +[permalinks] +post = "/blog/:year-:month-:day-:title/" # change the post URL to look like the old ones + + +[indexes] + tag = "tags" + category = "categories" + +# menu +# links will open in a new window except links to "/" - links are added to navigation in hugo-octopress/layouts/partials/navigation.html +[[menu.main]] + Name = "Blog" + URL = "/" + weight = -5 + +[[menu.main]] + Name = "Google" + URL = "https://www.google.com/" + weight = -5 + +[[menu.main]] + Name = "This theme on Github" + URL = "https://www.github.com/parsiya/hugo-octopress" + +[params] + + # number of recent posts that will be shown in the sidebar - default is 5 + SidebarRecentLimit = 5 + + # if false, all of the post will appear on front page (and in pagination) + truncate = true + + # author's name (this will appear in metadata and under posts) + author = "Author's name" + + # appears in the site header under website title + subtitle = "Subtitle appears under website title" + + # used in the search engine + search_engine_url = "https://www.google.com/search" + + # Text of the Continue Reading label. → == right arrow, but it gets messed up in the string so we will add it to index.html manually + continue_reading = "Would you like to know more?" + + # Google analytics code + googleAnalytics = "google analytics" + + # disqus shortcode + disqusShortname = "Your Google Analytics tracking code" + + # sidebar links + github = "https://github.com/parsiya/" + bitbucket = "https://bitbucket.org/parsiya/" + twitter = "https://twitter.com/cryptogangsta/" + keybase = "https://keybase.io/parsiya/" + stackoverflow = "" + linkedin = "" + googleplus = "" + youtube = "" + facebook = "" + + rss = true # switch to true to enable RSS icon link + + defaultDescription = "" + + # does this even work in action? + # defaultKeywords = ["keyword1" , "keyword2" , "keyword3" , "keyword4"] + +# blackfriday is Hugo's markdown engine. Options are at: https://gohugo.io/overview/configuration/ (scroll down to "Configure Blackfriday rendering") +[blackfriday] + hrefTargetBlank = true # open the external links in a new window + fractions = false |