Commit graph

431 commits

Author SHA1 Message Date
bep 599d1b9786 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 be920fdb2c Add a line in doc about the RelativeURL setting
Fixes #1145
2015-05-17 15:44:33 +02:00
bep be5f865c5c Add bugfix to releasenotes 2015-05-17 15:01:28 +02:00
bep be1bac9ff4 Add some bullet points to 0.14 rel notes 2015-05-16 18:11:52 +02:00
Andre R 84f4c21d4a Fix datePublished to publishdate 2015-05-16 15:58:37 +02:00
Rick Cogley 6b5ed88cde 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 6453bb5838 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 e522e5f415 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 be5fa2f3bd docs: reverse taxonomy entries 2015-05-12 18:46:55 +02:00
bep be72f234f8 docs: Use ToC length to pick the compact version 2015-05-11 22:23:35 +02:00
bep be82355570 Add doc for absURL and relURL
Also group URL related functions in doc.
2015-05-11 19:09:04 +02:00
bep be4f48652d 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 be16e5ffb9 Add absURL and relURL to release notes 2015-05-11 18:06:38 +02:00
bep be0c1bfe13 Add docs for Section Menu for “the Lazy Blogger” 2015-05-10 16:18:19 +02:00
bep be7e746f2b Add list of deprecated names to release notes 2015-05-10 15:41:13 +02:00
bep beb1735d04 Add issue to release notes 2015-05-10 15:26:03 +02:00
bep be52eff699 Some notes on 0.14 rel notes 2015-05-09 22:03:51 +02:00
Bill Traynor feba35cd1f 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 beccdc04f3 Add bind to release notes 2015-05-07 22:08:17 +02:00
Yosuke INOUE 3596b1b810 Add blackfriday/ExtensionsMask option. 2015-05-07 21:12:28 +02:00
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