add examplesite and modify the readme to reflect its additionexamplesite

1 files changed, 148 insertions, 0 deletions

diff --git a/exampleSite/config.toml b/exampleSite/config.toml
new file mode 100644
index 0000000..7d75d51
--- /dev/null
+++ b/exampleSite/config.toml
@@ -0,0 +1,148 @@
+
+baseurl = "https://example.com"
+disablePathToLower = false
+languageCode = "en-us"
+title = "Site title"
+theme = "hugo-octopress"
+
+# Needed so we can serve the example website without extra switches
+themesDir = "../.."
+
+# Disqus shortcode
+# Disable comments for any individual post by adding "comments: false" in its frontmatter
+# Note it's not under [params] anymore
+# disqusShortname = "Your disqus shortname"
+
+# Number of blog posts in each pagination page
+paginate = 6
+
+# Code highlighting options
+# Hugo uses Chroma but names are the same as the old pygments highlighter
+
+# Highlight shortcode and code fences (```) will be treated similarly
+pygmentscodefences = true
+
+# Change highlight style here.
+# For a full list see: https://xyproto.github.io/splash/docs/all.html
+pygmentsStyle = "solarized-dark"
+
+# Other Chroma options can be added here (and in the highlight shortcode in the markdown file)
+# See list of supported options: https://gohugo.io/content-management/syntax-highlighting/#options
+# for example: pygmentsoptions = "linenos=true"
+
+[permalinks]
+post = "/blog/:year-:month-:day-:title/" # change the post URL to look like the old ones
+
+[params]
+
+  # --- Start sidebar options ---
+  # Number of last posts that will be displayed in the sidebar - set to 0 or remove to hide this section
+  sidebarRecentLimit = 5
+
+  # Sidebar header - passed to markdownify so you can write markdown here
+  sidebarHeader = "Sidebar Header"
+
+  # Sidebar text also supports markdown
+  # New lines can be added with two spaces at the end of line. New paragraphs can be added with two an empty line.
+  # when adding two new lines, remember to remove the indentation otherwise the new line will be treated as a codeblock
+  sidebarText = """Here's a [link to example.net](https://www.example.net)
+
+  New paragraph
+
+  Another paragraph which has two spaces in the end to create a new line using markdown  
+  New line but not a new paragraph
+  """
+  # Sidebar menu - if true will add a sidebar menu between sidebar text and recent posts
+  sidebarMenuEnabled = true
+  sidebarMenuHeader = "Sidebar Links"
+
+  # sidebar links
+  github = "https://github.com/parsiya/Hugo-Octopress"
+  bitbucket = "https://bitbucket.org/parsiya/"
+  twitter = "https://twitter.com/cryptogangsta/"
+
+  # --- End sidebar options ---
+
+  # If set to true, navigation menu links will open in a new window with the exception of links to root ("/")
+  # If this item does not exist or set to false, then navigation menu links will open in the same window
+  navigationNewWindow = true
+
+  # If false, all of blog post will appear on front page (and in pagination)
+  truncate = true
+
+  # Author's name (appears in meta tags and under posts)
+  author = "Author"
+
+  # This text appears in the site header under website title
+  subtitle = "Subtitle appears under the website title"
+
+  # Search engine URL
+  searchEngineURL = "https://www.google.com/search"
+
+  # Text of the "Continue Reading" label. Supports markdown and inline HTML.
+  # For example, → == right arrow.
+  continueReadingText = "Would you like to know more? →"
+
+  # Switch to true to enable RSS icon link
+  rss = true
+
+  # Set to true to use a text label for RSS instead of an icon
+  # This is overwritten by the "rss" setting
+  textrss = false
+
+  # Website's default description
+  description = ""
+
+  # 404.html header and text - both support markdown
+  notFoundHeader = "There's nothing here"
+
+  notFoundText = """Please either go back or use the navigation/sidebar menus.
+  """
+
+  # Set to true to hide ReadingTime on posts
+  disableReadingTime = false
+
+  # Set to true to disable downloading of remote Google fonts
+  disableGoogleFonts = true
+
+  # Generate taxonomy pages
+  generateTaxonomyList = true
+
+# Menu
+# If navigationNewWindow (under [params]) is set to true then all links except root ("/") will open in a new window
+# If it does not exist or is set to false then links will open in the same window
+[[menu.main]]
+  Name = "Site's Home Page"
+  URL = "/"
+  weight = -5
+
+[[menu.main]]
+  Name = "example.net"
+  URL = "https://www.example.net/"
+  weight = -5
+
+[[menu.main]]
+  Name = "This theme on Github"
+  URL = "https://www.github.com/parsiya/hugo-octopress"
+
+[[menu.main]]
+  Name = "The About page"
+  URL = "/about"
+
+# Sidebar menus
+# Enable with "sidebarMenuEnabled = true" under [params]
+# Header text is "sidebarMenuHeader" under [params]
+[[menu.sidebar]]
+  Name = "example.net"
+  URL = "https://www.example.net"
+  weight = 0
+
+[[menu.sidebar]]
+  Name = "Hugo category"
+  URL = "/categories/golang/"
+  weight = 1
+
+[[menu.sidebar]]
+  Name = "About page"
+  URL = "/about"
+  weight = 2