github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-27 03:01:47 +00:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/extras/comments.md

101 lines
3.4 KiB
Markdown
Raw Normal View History

Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
---
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
date: 2014-05-26
linktitle: Comments
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
menu:
main:
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
parent: extras
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</*…*/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode.
2014-11-25 08:07:18 +00:00
next: /extras/crossreferences
Converting front matter to YAML
2014-05-29 22:42:05 +00:00
prev: /extras/builders
title: Comments in Hugo
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</*…*/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode.
2014-11-25 08:07:18 +00:00
weight: 30
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
---
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.
Docs copyediting: Add more external URLs; add backticks, etc.
2014-12-27 07:50:08 +00:00
Hugo ships with support for [Disqus](https://disqus.com), a third-party
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
service that provides comment and community capabilities to website via
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
JavaScript.
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
Your theme may already support Disqus, but even it if doesn’t, it is easy
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
to add.
# Disqus Support
## Adding Disqus to a template
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
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:
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
{{ template "_internal/disqus.html" . }}
## Configuring Disqus
More proofreading and minor revisions to Hugo docs Among the various changes, most instances of {{ template "partials/FILE.html" . }} were changed to {{ partial "FILE.html" . }} Also, in main.go, change "2013" to "2013-14".
2014-09-03 04:12:26 +00:00
That template requires you to set a single value in your site config file, e.g. config.yaml.
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
disqusShortname = "XYW"
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
Additionally, you can optionally set the following in the front matter
for a given piece of content:
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
* **disqus_identifier**
* **disqus_title**
* **disqus_url**
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
## Conditional Loading of Disqus Comments
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
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:
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
```javascript
<div id="disqus_thread"></div>
<script type="text/javascript">
(function() {
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
// Don't ever inject Disqus on localhost--it creates unwanted
// discussions from 'localhost:1313' on your Disqus account...
if (window.location.hostname == "localhost")
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
return;
var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;
var disqus_shortname = '{{ .Site.Params.disqusShortname }}';
dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';
(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq);
})();
</script>
<noscript>Please enable JavaScript to view the <a href="http://disqus.com/?ref_noscript">comments powered by Disqus.</a></noscript>
<a href="http://disqus.com" class="dsq-brlink">comments powered by <span class="logo-disqus">Disqus</span></a>
```
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
Notice that there is a simple `if` statement that detects when you are running on localhost and skips the initialization of the Disqus comment injection.
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
Now, reference the partial template from your page template:
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
More proofreading and minor revisions to Hugo docs Among the various changes, most instances of {{ template "partials/FILE.html" . }} were changed to {{ partial "FILE.html" . }} Also, in main.go, change "2013" to "2013-14".
2014-09-03 04:12:26 +00:00
{{ partial "disqus.html" . }}
Included instructions for omitting disqus comments on localhost.
2014-06-06 05:32:06 +00:00
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
# Alternatives
Docs copyediting: Add more external URLs; add backticks, etc.
2014-12-27 07:50:08 +00:00
A few alternatives exist to [Disqus](https://disqus.com):
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
Minor copyediting, no new content added.
2014-12-24 11:55:11 +00:00
* [IntenseDebate](http://intensedebate.com/)
* [Livefyre](http://livefyre.com/)
* [Muut](http://muut.com)
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
* [多说](http://duoshuo.com/) ([Duoshuo](http://duoshuo.com/), popular in China)
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
* [Kaiju](http://github.com/spf13/kaiju)
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
[Kaiju](http://github.com/spf13/kaiju) is an open-source project started
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
by [spf13](http://spf13.com) (Hugo’s author) to bring easy and fast real
time discussions to the web.
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
Written using Go, Socket.io and MongoDB, it is very fast and easy to
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
deploy.
Minor proofreading corrections to Hugo docs - 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"
2014-10-07 23:52:58 +00:00
It is in early development but shows promise. If you have interest,
Updating / Rewriting / Adding all of the documentation in preparation for the next release
2014-05-27 22:32:57 +00:00
please help by contributing whether via a pull request, an issue or even
just a tweet. Everything helps.
Reference in a new issue Copy permalink