595 Commits

Author SHA1 Message Date
spf13
6bdbf30fa6 Update release notes in prep for v0.14.0 2015-05-23 22:04:12 -04:00
bep
816103a33f docs: some more on absURL, relURL 2015-05-22 23:43:02 +02:00
bep
393d0d4f7e docs: add doc for substr
Fixes #1156
2015-05-22 22:36:25 +02:00
bep
8006a6f735 docs: add doc for slicestr
See #1156
2015-05-22 22:20:45 +02:00
bep
f6f56c805e docs: add doc for seq
See #1156
2015-05-22 22:17:41 +02:00
bep
30c9dd891b docs: add ToC to some more pages 2015-05-22 20:45:52 +02:00
bep
da3971eced docs: avoid navbar hiding when jumping to in-page anchor 2015-05-22 20:18:22 +02:00
Jeff Ramnani
9b3877b88c Docs: Add taxonomy term variables to the list of vars.
Taxonomy Term pages have variables in addition to those on "node"
pages.  Documenting these variables with all the other node variables
makes them easier to find.

Fixes: #1155
2015-05-22 19:41:34 +02:00
Jeff Ramnani
17977471a5 Add ".Render" to the list of functions.
Fixes: #1153
2015-05-22 19:38:01 +02:00
Rick Cogley
f73b47ec1f Clarifying Edits for templates/rss.md
Added clarification for RSS doc page.

* a little formatting to make key words jump out
* emphasize that you can create your own
* add how to link to the feed in <head>
* add what .RSSlink does
* added point that a link to an RSS feed should be of type application/rss+xml
2015-05-22 19:35:27 +02:00
bep
d6575b17da Fix formatting in hugo command description 2015-05-21 20:05:29 +02:00
bep
72682b51ec Fix CLI command description for the top level
And regenerate the commands doc.
2015-05-21 13:30:11 +02:00
bep
28d3fcdefe Add gendoc command
Using the new, great auto-doc in Cobra.

This commit also contains a current result of that command added to a commands section in docs.

Fixes #1136
2015-05-19 10:57:21 -04:00
bep
dea7eff7de Add a line in doc about the RelativeURL setting
Fixes #1145
2015-05-17 15:44:33 +02:00
bep
47aa9fe93a Add bugfix to releasenotes 2015-05-17 15:01:28 +02:00
bep
15559b3abb Add some bullet points to 0.14 rel notes 2015-05-16 18:11:52 +02:00
Andre R
53ad8c7d8b Fix datePublished to publishdate 2015-05-16 15:58:37 +02:00
Rick Cogley
e2a28ef4db Edits on aliases, comments, theme customizing
Fleshed out aliases section, loading the "redirect" keyword so that it's easier to find. Specifically added a "how aliases work" section.

Added Discourse to comments section.

Fleshed out themes/customizing, because it seems to be the source of a lot of questions on the forum.
2015-05-16 15:38:18 +02:00
Rick Cogley
e52a71834c Edit docs extras syntax highlighting.md
Added a bunch of clarifying narrative, looking at the discussion forum for what people are asking about, and what I myself was confused about.

* clearer separation of advantage of each style - server or client side - at the top
* inconsistent newlines (different column widths) so I just removed them from obvious paragraphs
* added that the highlight shortcode is not used for the client-side javascripts
* Hugo is taking crap for Pygments being slow, so tried to emphasize that's it's in Pygment's lap. I got your back, Hugo.
* On client-side added prism example
* More clarity on how the css and js needs to be added to your templates
* Explained how the client-side scripts work
2015-05-16 15:31:16 +02:00
Rick Cogley
1fb0df61df Edits to templates/404.md
Added bit about how the 404.html page has to be set to load automatically - auto on Github but needs config on other web servers.

Also tweaked the text a little to emphasize it's a node type, and explain a little more about where the 404 template should be saved.
2015-05-16 00:05:45 +02:00
bep
1bd790124e docs: reverse taxonomy entries 2015-05-12 18:46:55 +02:00
bep
f70c67cdf3 docs: Use ToC length to pick the compact version 2015-05-11 22:23:35 +02:00
bep
2238ebd56b Add doc for absURL and relURL
Also group URL related functions in doc.
2015-05-11 19:09:04 +02:00
bep
68dd83a920 Add ToC to long pages
* A compact, fixed box in the right screen
* Only for big screens, > 1200 px wide
2015-05-11 18:39:42 +02:00
bep
199a60920c Add absURL and relURL to release notes 2015-05-11 18:06:38 +02:00
bep
4e93ad37f8 Add docs for Section Menu for “the Lazy Blogger” 2015-05-10 16:18:19 +02:00
bep
c09e94abfa Add list of deprecated names to release notes 2015-05-10 15:41:13 +02:00
bep
af88f3eb9c Add issue to release notes 2015-05-10 15:26:03 +02:00
bep
a70b820b80 Some notes on 0.14 rel notes 2015-05-09 22:03:51 +02:00
Bill Traynor
d32368f395 Added in set PATH and new site output.
I added in the instructions for how to add the hugo.exe to the PATH variable.  And I added in example output post new site command.

[close #1058]
2015-05-08 22:36:42 -04:00
bep
53a3e4c190 Add bind to release notes 2015-05-07 22:08:17 +02:00
Yosuke INOUE
98b13dfe02 Add blackfriday/ExtensionsMask option. 2015-05-07 21:12:28 +02:00
bep
b90a21b308 doc: move the index func reference to where it's used 2015-04-29 22:40:33 +02:00
Rick Cogley
e97bfb04cc 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
ca5bfedc61 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
701fe62e03 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
f82f1ce8ea 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
7a0a02023d Add shortcut to Scratch from shortcode 2015-04-19 14:50:27 +02:00
bep
251c10c8c0 doc: clarify Scratch usage in shortcodes 2015-04-19 11:30:11 +02:00
bep
5a8a31881d Check spelling and some minor additions to Ace doc 2015-04-18 23:06:18 +02:00
bep
89089406da Add doc for Ace templates
Fixes #1063
2015-04-18 20:23:28 +02:00
bep
956238622e Add more options to highlight
Fixes #1021
2015-04-15 20:31:06 +02:00
Florian Baumann
d652d91e96 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
2021150d52 Add "Google Cloud Storage" article to docs Press page
See #1055
2015-04-10 14:19:54 -06:00
Samuel Lelièvre
9e35e20aab Typo in mathjax.md 2015-04-10 18:18:14 +02:00
complexsplit
2a151abc8c Add Google Cloud Storage to doc 2015-04-10 18:12:59 +02:00
mdhender
43d6fdc123 Document getenv template function
Add `getenv` to the template function documentation.
2015-04-05 18:14:40 +02:00
mdhender
a03c130284 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
a339a1a06a 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
db830e26e4 docs: how to compile on mac, fix minor errors 2015-04-04 22:30:42 +02:00