From ca7007bf26c9d81ef218f0a274fe3a9a77b1b188 Mon Sep 17 00:00:00 2001 From: Anthony Fok Date: Tue, 7 Oct 2014 17:52:58 -0600 Subject: [PATCH] Minor proofreading corrections to Hugo docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add backticks and commas where necessary - Remove some trailing whitespace - Add front matter example in TOML - Fix typo in one of the tags in Showcase - Add 多说 (Duoshuo) as an alternative to Disqus - Use internal links (i.e. without gohugo.io) where possible - Use a colon to set off an example - Change "it's" to "its" where appropriate - Use typographical (i.e. curly) apostrophe on the front page where appropriate - Capitalize "Github" as "GitHub" --- docs/content/community/mailing-list.md | 2 +- docs/content/extras/comments.md | 35 +++++----- docs/content/extras/menus.md | 4 +- docs/content/extras/shortcodes.md | 76 ++++++++++----------- docs/content/overview/configuration.md | 2 +- docs/content/overview/introduction.md | 2 +- docs/content/overview/quickstart.md | 2 +- docs/content/overview/usage.md | 12 ++-- docs/content/showcase/ucsb.md | 2 +- docs/content/taxonomies/displaying.md | 26 +++---- docs/content/taxonomies/overview.md | 10 +-- docs/content/taxonomies/usage.md | 13 +++- docs/content/templates/go-templates.md | 2 +- docs/content/tutorials/github_pages_blog.md | 2 +- docs/layouts/index.html | 14 ++-- docs/layouts/section/showcase.html | 2 +- 16 files changed, 109 insertions(+), 97 deletions(-) diff --git a/docs/content/community/mailing-list.md b/docs/content/community/mailing-list.md index fa0150f3e..4961b747b 100644 --- a/docs/content/community/mailing-list.md +++ b/docs/content/community/mailing-list.md @@ -11,7 +11,7 @@ weight: 10 # Discussion Forum -Hugo has it’s own [discussion forum](http://discuss.gohugo.io) powered by [Discourse](http://www.discourse.org/) +Hugo has its own [discussion forum](http://discuss.gohugo.io) powered by [Discourse](http://www.discourse.org/). Please use this for all discussions, questions, etc. diff --git a/docs/content/extras/comments.md b/docs/content/extras/comments.md index 9f7040f86..c11c2eceb 100644 --- a/docs/content/extras/comments.md +++ b/docs/content/extras/comments.md @@ -14,19 +14,19 @@ As Hugo is a static site generator, the content produced is static and doesn’t interact with the users. The most common interaction people ask for is comment capability. -Hugo ships with support for [disqus](http://disqus.com), a third party +Hugo ships with support for [Disqus](http://disqus.com), a third-party service that provides comment and community capabilities to website via -javascript. +JavaScript. -Your theme may already support disqus, but even it if doesn’t it is easy +Your theme may already support Disqus, but even it if doesn’t, it is easy to add. # Disqus Support ## Adding Disqus to a template -Hugo comes with all the code you would need to include load disqus. -Simply include the following line where you want your comments to appear +Hugo comes with all the code you would need to include load Disqus. +Simply include the following line where you want your comments to appear: {{ template "_internal/disqus.html" . }} @@ -37,8 +37,8 @@ That template requires you to set a single value in your site config file, e.g. disqusShortname = "XYW" -Additionally you can optionally set the following in the front matter -for a given piece of content +Additionally, you can optionally set the following in the front matter +for a given piece of content: * **disqus_identifier** * **disqus_title** @@ -47,16 +47,16 @@ for a given piece of content ## Conditional Loading of Disqus Comments -Users have noticed that enabling disqus comments when running the hugo web server on localhost causes the creation of unwanted discussions on the associated disqus account. In order to prevent this, a slightly tweaked partial template is required. So, rather than using the built-in `"_internal/disqus.html"` template referenced above, create a template in your `partials` folder that looks like this: +Users have noticed that enabling Disqus comments when running the Hugo web server on localhost causes the creation of unwanted discussions on the associated Disqus account. In order to prevent this, a slightly tweaked partial template is required. So, rather than using the built-in `"_internal/disqus.html"` template referenced above, create a template in your `partials` folder that looks like this: ```javascript