Commit graph

461 commits

Author SHA1 Message Date
bep beacfcf865 doc: move the index func reference to where it's used 2015-04-29 22:40:33 +02:00
Rick Cogley da08fad5f3 Add index reference to go template primer doc page
Related to @bjornerik 's answer in this discussion: http://discuss.gohugo.io/t/inserting-data-from-data-file-into-content-file-newbie-question/1002/3 ... I figured I'd make myself useful and add the reference to the index function, on the go template primer page.

Also, I moved the reference links to the bottom.

A general comment: as good as these docs are, the primer at this point makes some assumptions about audience knowledge, so some might find it lacking. Once I understand better, I might make some more clarifying edits.
2015-04-29 21:06:21 +02:00
Rick Cogley a8f91ace11 Clarify partials folder subfolders
A couple of edits to clarify that the layout/partials folder can contain arbitrarily-named subfolders, since I found the examples using ``{{ partial "post/tag/list" . }}`` confusing. Some folders are named specifically to work a certain way with hugo, but although the examples use key functional section and taxonomy names like post and tag, it does not matter what they are called. Hopefully this will help other newbs.
2015-04-27 11:44:26 +02:00
Rick Cogley 9e13ac9a8f Single rather than double backticks in types.md
Whoops, I had the new hugo new as double backticks but it appears only single are needed.
2015-04-25 00:06:29 +02:00
Rick Cogley 6b69f951c8 Clarify hugo new command in types.md
Elsewhere in the docs commands are entered as code, so to be consistent with that, added backticks and the word hugo.
2015-04-25 00:06:28 +02:00
bep be01f8430e Add shortcut to Scratch from shortcode 2015-04-19 14:50:27 +02:00
bep bef25432d1 doc: clarify Scratch usage in shortcodes 2015-04-19 11:30:11 +02:00
bep be62c94872 Check spelling and some minor additions to Ace doc 2015-04-18 23:06:18 +02:00
bep be7c1e5dd4 Add doc for Ace templates
Fixes #1063
2015-04-18 20:23:28 +02:00
bep be24457acf Add more options to highlight
Fixes #1021
2015-04-15 20:31:06 +02:00
Florian Baumann 0fcb78e43b Added isso as a Disqus alternative to the docs
Hi,

I'm using isso with my hugo blog which works just fine.
I think this should be added to the docs :)

Thanks!
2015-04-10 22:45:22 -06:00
Anthony Fok 1b5b0b3a94 Add "Google Cloud Storage" article to docs Press page
See #1055
2015-04-10 14:19:54 -06:00
Samuel Lelièvre 1f4a3c1f38 Typo in mathjax.md 2015-04-10 18:18:14 +02:00
complexsplit 3b1db70af5 Add Google Cloud Storage to doc 2015-04-10 18:12:59 +02:00
mdhender 42dcaabf4f Document getenv template function
Add `getenv` to the template function documentation.
2015-04-05 18:14:40 +02:00
mdhender 9a499b56c9 Add a section comparing the 'build' and 'server'
One of the first things that new users have to understand is the
difference between Hugo as a web server and Hugo as a web site
generator. Issue #852 asked for documentation to make that clear.

This patch updates the overview page with that information. It will
seem repetitive to users that understand the difference. Weigh that
against the needs of those that don't.

Reference #852
2015-04-04 23:58:10 +02:00
mdhender 6b50c8fb82 Sort function names in templates documentation
The documentation on the functions is long.  It is easier to find
a function name when they are sorted within the sections.

Fixes #981
2015-04-04 23:30:08 +02:00
Alex Dunn 9de78aab3f docs: how to compile on mac, fix minor errors 2015-04-04 22:30:42 +02:00
bep 72aa516c75 documentation: mention data files under liverload 2015-04-01 23:26:33 +02:00
bep bec22f8981 Add pager size argument to paginator methods
Fixes #1013
2015-03-31 19:12:56 +02:00
mdhender 06d704f243 Updates documentation with instructions for a Windows computer
Adds step-by-step instructions for installing from the official
tarball.

Fixes #1007
2015-03-31 00:35:38 -06:00
Bruno Clermont 3b2e1006fc Capitalize singular
Added in #523 it's ``Data.Singular``
2015-03-30 16:55:55 +02:00
Michael Henderson 0ab345236d Updates documentation with instructions for a Mac
Adds step-by-step instructions for installing from both brew and
the official tarball. Not sure if steps for installing from source
belong here, so left them out.

Fixes #1005
2015-03-30 16:54:38 +02:00
sainaen 6a539db58e Update embedded rss.xml code in the docs 2015-03-30 16:50:44 +02:00
Anthony Fok b3bd71fec9 Update Hugo docs with the initialisms suggested by golint
In particular:

 * .Url → .URL (for node, menu and paginator)
 * .Site.BaseUrl → .Site.BaseURL
 * getJson → getJSON
 * getCsv → getCSV
 * safeHtml → safeHTML
 * safeCss → safeCSS
 * safeUrl → safeURL

Continued effort in fixing #959.
2015-03-18 11:30:37 +01:00
Anthony Fok ca69cad8aa Press: Add "Migrating to Hugo From Octopress" by Nathan LeClaire 2015-03-18 00:32:19 -06:00
Anthony Fok a220a3ba37 [Docs] Copyedit http://gohugo.io/extras/dynamiccontent/ 2015-03-17 23:53:17 -06:00
Anthony Fok f848dc92db [Docs] Update and expand http://gohugo.io/overview/usage/
The `hugo help` output as shown in http://gohugo.io/overview/usage/
was not yet updated for v0.13. Thanks to @alebaffa for the heads up!

Also:
 - Clarify that, after using `hugo server`, the bare `hugo` command
   need to be run before deployment.
 - Add a section on running `hugo` as production web server,
   and add links to two blog posts of two Hugo users sharing
   their experience.

Partially fixes: #852 and #937
2015-03-12 08:53:48 -06:00
Anthony Fok d3c0fde5be Update press coverage: Fix URL; new tutorial in Chinese 2015-03-12 08:50:31 -06:00
Saint Asky ecb2aca6a2 Update github-pages-blog.md
change `hugo serve` to `hugo server`
2015-03-05 01:46:06 -07:00
bep ab5862cd00 Allow the same shortcode to be used with or without inline content
Fixes #934
2015-03-02 21:49:33 +01:00
Anthony Fok bb13d82677 [Docs] NetBSD and ARM pre-built binaries are already provided
See https://github.com/spf13/hugo/releases

What a pleasant surprise indeed!
How come I have never noticed them before?

And even `.deb` files are provided!  How amazing!
2015-02-21 23:26:34 -07:00
spf13 e43eabacee Updating the final release notes for v0.13 2015-02-21 22:31:01 -05:00
Anthony Fok 88e7c031a8 [Docs] Clarify the switch to canonifyurls = false as default
Quote from @spf13: "I also think it's the better default
and should continue to be the case going forward."

Also mention the use of `hugo config` to check the current value
of `canonifyurls`, thanks to suggestion by @bep.

Fixes #802
2015-02-21 14:50:14 -07:00
Anthony Fok ac189fd514 Update README.md and overview/installing.md
- Clarify that Hugo may be built wherever Go is available;
- Add links to Git, Mercurial and Go;
- Unlist Bazaar: No libraries that Hugo depends on use it any more;
- Suggest the user to simply run `make` to build `hugo`
  to get `hugo version` to display the commit hash.
2015-02-21 13:42:15 -07:00
riboflavin aeddaee901 add note that running with watch doesn't produce a site suitable for deployment 2015-02-17 19:17:38 -08:00
karland e31536dd85 Add information to highlighting with Payments
Conflicts:
	docs/content/extras/highlighting.md
2015-02-17 12:35:39 -05:00
Cyrill Schumacher 41c0e82f95 Moved futured getSQL topic to another branch 2015-02-17 12:14:39 -05:00
Cyrill Schumacher b209f44335 getJson and getCsv documentation proof reading by @msjulias 2015-02-17 12:14:39 -05:00
Cyrill Schumacher 4342dd84fc Update Dynamic Content docs 2015-02-17 12:14:39 -05:00
Cyrill Schumacher 48a6d44786 Update doc 2015-02-17 12:14:39 -05:00
Cyrill Schumacher 47b7cfeb44 Add getSQL idea 2015-02-17 12:14:39 -05:00
Cyrill Schumacher fdf8db9c21 Initial doc file: Dynamic Content 2015-02-17 12:14:39 -05:00
Anthony Fok cb9fa62743 [Docs] Minor copyediting of highlighting.md
Also add `apt-get` command for installing Pygments.
2015-02-17 01:59:40 -07:00
karland bd0de85dbc Add information to highlighting with Pygments 2015-02-17 01:49:44 -07:00
karland 1827680bea List of variables
Some variables are currently not documented and others are explained
across the document. So, I tried to pull an overview from the source.
Pls double check. I am not 100% sure, what the purpose of some variables
is or whether they are only relevant for previous versions. Thanks
2015-02-17 01:28:20 -07:00
Maxime Michel 09ed3c4b92 Fixed a typo 2015-02-17 01:16:41 -07:00
Anthony Fok 63e7b9705f [Docs] Add pointers to roadmap; new tweet and article 2015-02-16 09:02:56 -07:00
Ivan Fraixedes 366f991694 Another link in the same page 2015-02-14 18:35:37 -05:00
Ivan Fraixedes b389a92383 Fixed invalid link to partials 2015-02-14 18:35:37 -05:00
Joseph Kaptur 462e666f45 Update docs so that figure includes the class parameter. 2015-02-14 18:35:00 -05:00
bep 87975e04eb Remove nohup.out committed by accident 2015-02-12 14:32:04 +01:00
bep 4820683330 Doc Data Files: Add section about themes and expanded the example a bit 2015-02-12 09:09:35 +01:00
Anthony Fok 664fd99135 Change "ctrl+c" to "Ctrl+C" 2015-02-11 01:11:50 -07:00
midinastasurazz dbb86679a1 Fix typo: GetJson -> GetCsv 2015-02-11 00:57:17 -07:00
Greg Restall 7e28db18f2 Add showcase entry for consequently.org
Consequently.org is a personal site for an academic, with a blog, list
of publications, classes and talks, all managed by hugo.
2015-02-11 00:31:44 -07:00
spf13 e3daa359ec Update release notes for v0.13 2015-02-10 10:58:20 -05:00
bep 371c148c34 Fix alias for data files doc 2015-02-09 16:58:12 +01:00
bep 03fff880ec Add docs for Data Files
Fixes #887
2015-02-09 16:52:52 +01:00
Anthony Fok 4c7e119ca1 [Docs] Say which directory to clone the hugoThemes
On http://gohugo.io/overview/quickstart/, explicitly state
that hugoThemes is to be cloned from within the working directory,
like it is stated on http://gohugo.io/themes/installing/.

Fixes #886
2015-02-08 19:52:27 -07:00
bep dd9344816a Scratch doc: Use the special $ variable to prevent confusion 2015-02-01 20:36:43 +01:00
bep f264076f66 Add doc for Scratch 2015-01-31 22:01:30 +01:00
Anthony Fok 659f71e617 [Docs] Fix more missing . in example partial calls 2015-01-31 07:27:42 -07:00
Dan Hatch 20bed49f52 Fixed syntax error in 404.html template code 2015-01-31 01:01:50 -07:00
Anthony Fok d397bc4f43 [Docs] Complete the transition from "indexes" to "taxonomies" (almost)
Also mention `.Site.Indexes` → `.Site.Taxonomies` as well as
the upcoming `.Site.Recent` → `.Site.Pages` transitions.
2015-01-29 12:48:14 -07:00
Anthony Fok ba44e860a3 [Docs] Copyediting
* Add meta author, description and generator tags
 * Add Hugo version beside the logo and in the footer
 * Suggest the user to run `go get -u -v` to update dependencies
 * Requires Go 1.3+ rather than Go 1.1+
 * Improve rendering/formatting in some places
 * Add trailing slash to URLs where appropriate
 * GitHub redirects all http requests to https, update accordingly
2015-01-28 18:02:40 -07:00
Anthony Fok 82d4b8ab40 [Docs] Use OptiPNG to shrink PNG images losslessly
So they load slightly faster.  :-)
2015-01-28 13:25:07 -07:00
Anthony Fok 8e6cbe82f3 Some housekeeping of the Showcase and Press pages 2015-01-28 13:25:07 -07:00
Dan Hersam 06b1a88358 Added three videos to documentation.
Created shortcode for YouTube videos and made the videos responsive in the
stylesheet.
2015-01-27 23:44:46 +01:00
bep 0b5f8c8cb3 [doc] Improve paginator doc 2015-01-27 21:56:45 +01:00
bep 0c2297075a Linkify release notes 2015-01-26 20:42:08 +01:00
bep fb594fc6e0 Set detault for Paginate to 10
10 is a better default than 0, since no paginator pages will be created unles referenced by a `.Paginator`.

See #750
2015-01-26 15:26:19 +01:00
bep a6d22bcf7d Add documentation for pagination
See #750
2015-01-26 14:56:26 +01:00
bep 3628d0bbc6 Add pagination to release notes 2015-01-26 13:06:32 +01:00
Naoya Inada 407e80a9ab Add site-wide/per-page [blackfriday] extensions option 2015-01-26 09:55:37 +01:00
Wade Wegner 39b2cdece0 Wrong URL for Github Pages 2015-01-25 23:00:16 -07:00
Kartik Singhal ea72f15f38 Correct wercker URL 2015-01-25 09:44:28 -07:00
Naoya Inada 57b4f3310b Fix inverse notation 2015-01-25 00:13:10 -07:00
Anthony Fok eb686352b1 Add site-wide/per-page [blackfriday] fractions option
Make Blackfriday's `HTML_SMARTYPANTS_FRACTIONS` option
user-configurable.  Defaults to `true` as before.  See
discussions at:

http://discuss.gohugo.io/t/any-way-to-disable-smart-fractions/328

Thanks to @bjornerik and @spf13 for laying the groundwork
making it easy to expose Blackfriday's underlying configurable
options.
2015-01-24 20:57:40 +01:00
Anthony Fok b345ca26cb [Docs]: Add new press/blog coverage about Hugo 2015-01-23 11:46:39 -07:00
bep 1b42dc572a Fix RelPermalink() and Urls in menus vs canonifyUrls
canonifyUrls=true, RelPermalink and baseUrl with sub-path did not work.

This fixes that by adding a check for canonifyUrl=trues=true in RelPermalink().

So given

- baseUrl "http://somehost.com/sub/"
- the path "some-path/file.html"

For canonifyUrls=false RelPermalink() returns "/sub/some-path/file.html"
For canonifyUrls=true RelPermalink() returns "/some-path/file.html"

In the last case, the Url will be made absolute and clickable in a later step.

This commit also makes the menu urls defined in site config releative. To make them work with canonifying of urls, the context root is prepended if canonifying is turned off.

Fixes #519
Fixes #711
2015-01-23 14:13:00 +01:00
Anthony Fok 743998306a [Docs] Document the new (temp?) default of canonifyurls = false
Also add a **Caveat** on http://gohugo.io/tutorials/github-pages-blog/
warning the reader that a `canonifyurls = true` must be added
for Spencer's old example files to work.

Fixes #802
2015-01-22 18:04:07 -07:00
bep 6db6d33bec Add dateFormat to release notes 2015-01-22 01:19:02 +01:00
Tatsushi Demachi 37490ee27a Add dateFormat template function
This is the implementation of the proposal at #235 and
http://discuss.gohugo.io/t/parsing-dates-in-templates/603/3
2015-01-22 00:08:30 +01:00
Peter Krautzberger e5be592ee0 fix outdated MathJax CDN URL
The rackspace address has been retired, see http://www.mathjax.org/changes-to-the-mathjax-cdn/
2015-01-21 03:16:04 -07:00
Anthony Fok 173aa53b8a [Docs] Use of $. to access global context from anywhere
See #804, http://discuss.gohugo.io/t/templates-multiple-parameters/600/3
and http://stackoverflow.com/questions/16734503/access-out-of-loop-value-inside-golang-templates-loop
for related discussions.
2015-01-21 00:35:12 -07:00
Anthony Fok f015e9b8e0 [Docs] Recommend the use of backticks for IE conditionals
Special thanks to @tatsushid and @bjornerik for the insight!

Fixes #778.
2015-01-20 23:45:26 -07:00
Anthony Fok a17c290a33 [Docs] Correct description of "Read More" links in Summaries
Also revise some paragraphs for succinctness.

Fixes #788
2015-01-20 15:45:57 -07:00
Nikolay Kirsh 932214d725 fix --uglyUrls params 2015-01-20 13:51:15 -07:00
Anthony Fok 1348caa6de [Docs] Add a note about the plan to switch to Apache License 2015-01-20 07:49:50 -07:00
Anthony Fok 2342655fde [Docs] Incorporate some great ideas by @mohae into the safeUrl docs
E.g. how `#ZgotomlZ` is used to "defang" the URL
2015-01-20 00:24:47 -07:00
Anthony Fok 724cc0ddff Add safeUrl; disable safeHtmlAttr; rename safeCSS to safeCss
- Add `safeUrl` template function (Fixes #347)
- Add TestSafeUrl() fashioned after @tatsushid great examples
- Disable `safeHtmlAttr` pending further discussions on its other
  use cases because `safeUrl` is a cleaner solution to #347.
  (There are also `safeJs` and `safeJsStr` that we could implement
  if there are legitimate demands for them.)
- Rename `safeCSS` to `safeCss` (to follow the convention of `safeHtml`)
- Add/expand documentation on `safeHtml`, `safeCss` and `safeUrl`
2015-01-19 23:41:22 -07:00
Anthony Fok 53b4ab4cf3 Revert "[Docs] Use <dl> for definition lists of variables"
This reverts commit 5d6dfe81b8.

The extra styling in docs/static/css/style.css has been retained.
2015-01-19 11:44:14 -07:00
Anthony Fok 4609f77a80 [Docs] New testimonials and press coverage
Found on @spf13's Twitter.  :-)

Prevent the testimonial dates from wrapping.

Also fix a few minor problems to get the home page
to validate as proper HTML5.
2015-01-19 04:16:54 -07:00
Anthony Fok 0e60c5137e [Docs] Limit .fa { display: inline } within #main-content
Otherwise the items in the side menu won't line up.
Sorry about this oversight in my recent commit.
2015-01-19 02:49:50 -07:00
Anthony Fok b56c9db6dc [Docs] Add FreeBSD logo beside the FreeBSD name
Extracted from https://www.freebsd.org/logo/logo-simple.svg
for temporary use until a future Font Awesome release adds
the `fa-freebsd` glyph (github/FortAwesome/Font-Awesome#1116)  :-)

Make .fa `display: inline` to prevent unwanted line-wrapping

Also make the menu item "Issue & Help" line up with the others.
2015-01-19 02:48:44 -07:00
Anthony Fok 5d6dfe81b8 [Docs] Use <dl> for definition lists of variables
Hopefully making them more semantic and easier to read,
though it is raw HTML so it is slightly more work to maintain.

Also made minor revisions to some of the variable descriptions
to be more informative, e.g. `:monthname` in permalinks use
full English names ("January" etc.)
2015-01-19 01:30:38 -07:00
bep 56eead2ade Fix broken doc section 2015-01-19 08:14:57 +01:00
bep 7257ab6855 Update release notes with the new Hugo var 2015-01-19 02:58:27 +01:00
bep 109e6f95fd Merge branch 'master' of github.com:spf13/hugo 2015-01-19 02:41:16 +01:00