Commit graph

243 commits

Author SHA1 Message Date
Anthony Fok
b59dd163ec [Docs] More copyediting
* Add link to https://travis-ci.org/spf13/hugo
* Correct heading levels in docs/content/community/mailing-list.md
* Mention RFC 3339 as the `date` format set by `hugo new`
* Mention that `hugo new` does not add `draft = true` when the user
  provides an archetype
* List short examples of TOML and YAML side by side
* Compact the Math template functions into a table
* Put some notes into a blockquote
2015-01-17 00:45:53 -07:00
Tomas Roos
a4da52622c Missing . on footer partials 2015-01-16 03:39:38 -07:00
bep
4f66acdce7 First take on release notes for 0.13 2015-01-14 13:54:38 +01:00
Anthony Fok
fc39019ffe Add an alias to the old URL of github-pages-blog.md 2015-01-13 21:24:58 -07:00
Anthony Fok
433ce3b742 Rename github_pages_blog.md to github-pages-blog.md 2015-01-13 21:19:20 -07:00
Anthony Fok
4107fd50a8 [Docs] More random revision and copyediting
General revisions to (hopefully) make the documentation
easier to understand and more comprehensive.

Revise "Strange EOF error" troubleshooting page to say that
a fix is in place for the upcoming Hugo v0.13.

Also add more external links, and cute icons from Font Awesome.
2015-01-13 20:48:44 -07:00
Dan Hersam
6fda9012d6 Fixed error in tutorial, added site variable docs
While following the github pages tutorial I found some issues. These are
the commands I ran that worked.

Added site variables to the docs from the code.
2015-01-12 23:00:28 -07:00
Arjen Schwarz
6c5a7b7b64 Tutorial: Automated deployments
Also fixed the next/prev for the tutorials
2015-01-12 22:59:14 -07:00
Anthony Fok
5bfc812dc6 [Docs] Remove references to "ATOM" feeds
Thanks to @snej for reporting!

Fixes #790
2015-01-12 14:12:08 -07:00
David Kebler
b6ab661893 note in archetype.md to alert that ending carriage return may be nessary to avoid EOF errors. 2015-01-09 22:08:35 +01:00
Anthony Fok
b0181e278b Some more random copyediting of Hugo docs
- Change "livereload" and "live reload" to "LiveReload";
 - Add a `$ ` prompt before example command lines
   (not exhaustive, work in progress);
 - Remove unnecessary whitespace from partials;
 - Revise the blackfriday options table in overview/configuration.md
   to make it narrower.
 - Manually set the language for highlight.js where appropriate
 - Rename "404" to "Custom 404 page", and remove incorrect reference
   to "homepage"
 - Credit the author of tutorials/github_pages_blog.md
   (Similar notes are necessary for other contributed pages where
    "I" am not spf13 to avoid reader confusion.)
 - Add CSS for `kbd` and `table` etc. to css/style.css;
 - etc.
2015-01-09 11:51:15 -07:00
Anthony Fok
190964c57b [Docs] New Troubleshooting section
With two entries of frequently encountered or obscured troubles so far:

- "Categories with accented characters" Unicode NFC/NFD mismatch
   on Mac OS X (See #739)
- `hugo new` aborts with cryptic EOF error (See #776)
2015-01-08 18:29:05 -07:00
Jacob Gillespie
c0f54aefe3 Rename to plainIdAnchors 2015-01-05 21:00:22 +01:00
Jacob Gillespie
a0e44bb71d Add Blackfriday: documentIDAnchor documentation 2015-01-05 21:00:22 +01:00
philgs
dca6eabaca Add config file example to variables.md
Add a config file example for setting .Site.Params to variables.md. This addresses my confusion in [issue #766](https://github.com/spf13/hugo/issues/766).
2015-01-05 18:51:36 +01:00
philgs
0b7392b3db Update configuration.md
Update configuration.md to show setting variables for .Site.Params in TOML config file
2015-01-05 18:51:36 +01:00
philgs
e6c27f76aa Add example code to Summaries
I was initially confused about how to use summaries. The only example code I found in the docs was on the page for list nodes, but that uses `Render "summary"`, which is for views, not an article summary. I thought a little example here might clarify the issue for future users.
2015-01-05 18:44:25 +01:00
Dave Johnston
a5f5106154 Add in-section Next/Prev content pointers
Conflicts:
	docs/content/meta/release-notes.md
	docs/content/templates/variables.md
2015-01-05 18:26:09 +01:00
Tatsushi Demachi
0d17ee7ed4 Add operator argument to where template function
It allows to use `where` template function like SQL `where` clause.
For example,

    {{ range where .Data.Pages "Type" "!=" "post" }}
        {{ .Content }}
    {{ end }}

Now these operators are implemented:

    =, ==, eq, !=, <>, ne, >=, ge, >, gt, <=, le, <, lt, in, not in

It also fixes `TestWhere` more readable
2015-01-04 12:15:17 +01:00
Austin Ziegler
ae9c25afc0 Implement apply.
- apply seq fn args…
2015-01-02 11:50:22 +01:00
Austin Ziegler
6033abe1e7 Add a chomp function.
- Mostly useful in pipelines.
2015-01-02 11:50:22 +01:00
Tom Helmer Hansen
d3c3676161 Fix EOF 2014-12-30 12:28:19 -07:00
Tom Helmer Hansen
ec2566fa95 Add www.thehome.dk to showcase 2014-12-30 12:28:19 -07:00
Tatsushi Demachi
fa8ac87d5e Make 'where' template function accepts dot chaining key argument
'where' template function used to accept only each element's struct
field name, method name and map key name as its second argument. This
extends it to accept dot chaining key like 'Params.foo.bar' as the
argument. It evaluates sub elements of each array elements and checks it
matches the third argument value.

Typical use case would be for filtering Pages by user defined front
matter value. For example, to filter pages which have 'Params.foo.bar'
and its value is 'baz', it is used like

    {{ range where .Data.Pages "Params.foo.bar" "baz" }}
        {{ .Content }}
    {{ end }}

It ignores all leading and trailing dots so it can also be used with
".Params.foo.bar"
2014-12-29 12:53:41 +01:00
Anthony Fok
dd5bc0345b [Docs] Mention support for the Ace HTML Template Engine 2014-12-27 00:58:50 -07:00
Anthony Fok
ddf4190114 Docs copyediting: Add more external URLs; add backticks, etc. 2014-12-27 00:50:08 -07:00
Anthony Fok
5792cc3a1a [Docs] Go 1.4+ required for building on Windows
See Issue #688 for more information.
2014-12-26 13:00:14 -07:00
bep
afe5add86e Add anchor ref to Blackfriday doc 2014-12-26 18:11:05 +01:00
bep
a0fe117002 Add doc for Blackfriday configuration
See #686
2014-12-26 16:04:49 +01:00
Anthony Fok
8042e77488 Typo fix: "simple" → "simply" in templates/views.md
Thanks to @paulsullivan for catching that typo!
2014-12-24 16:58:28 -07:00
Anthony Fok
68cea07072 Minor copyediting, no new content added. 2014-12-24 04:59:53 -07:00
Derek Perkins
717f702e2f Added delimit & sort template functions, tests and docs 2014-12-18 22:28:12 -05:00
Austin Ziegler
fd33e5d202 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-12-18 22:18:37 -05:00
bep
9f0f73f452 Fix front matter for 'Creating a New Theme'
There seems to be an issue with TOML and certain menu structures. Current workaround: YAML.
2014-12-08 23:08:54 +01:00
Anthony Fok
a6d3862b87 Docs: Minor copyediting/proofreading
- Correct some typos
- Add backticks and commas where necessary
- Use fenced code blocks specifying "bash" as the language
  to avoid weird highlighting
- Place commas outside of quotation marks surroundingn codes
  to avoid possible confusion
- Suggest users to use the discussion forum rather than the
  mailing list
2014-12-08 22:44:30 +01:00
Anthony Fok
736dd4b521 Docs: Quote <!--more--> in <code> instead of italicizing it
Also replace "--" with "&#x2d;&#x2d;" prevent "--" from
being interpreted as en-dash.

Note: A simple `<!--more-->` does not work.
2014-12-08 22:44:30 +01:00
Augustin Riedinger
390c158f4e Github page strategy for username.github.io repos
The whole article should maybe be rewriten to have a better content flow (maybe adding a table of content), to introduce both possible strategies. But at least, the technical steps are there!
2014-12-03 15:03:18 +01:00
Rasmus Stougaard
1b36bda653 Fixed typo in summaries description in the documentation 2014-12-03 13:55:52 +01:00
Alex Dunn
c00788d8be showcase: update ucsb entry 2014-12-03 13:53:29 +01:00
Kartik Singhal
742a064b24 Correct alias 2014-12-03 09:17:45 +01:00
bep
df8e936687 Fix missing shortcode in doc
Use new syntax for example.
2014-12-03 09:17:04 +01:00
bep
d616617292 Doc for markdownify
This small function feels important enough to maybe deserve more than these three lines, but this will have to do for now.

This assumes that #652 gets merged.
2014-11-24 23:18:18 -05:00
Joel Scoble
f04006978a update summary.md with info on handling of html tags 2014-11-24 23:03:10 -05:00
Kartik Singhal
9b850c4adb Correct path in theme search order 2014-11-24 17:24:39 -05:00
Rasmus Stougaard
9e15298952 Added link to my blogpost about travelling with Hugo in asia 2014-11-24 17:23:38 -05:00
Rasmus Stougaard
a1954c4fc6 Added stou.dk to showcases 2014-11-24 17:23:37 -05:00
Dan Connolly
6c25cd529f typo: practical 2014-11-24 17:14:11 -05:00
bep
728d0fa32c Update shortcode doc for 0.13-DEV
Update of the doc to reflect the shortcode  implemention in HEAD.
2014-11-18 12:26:33 -05:00
ls6
bcaf33418f Update shortcodes.md
A typo resulting in a broken link.
2014-11-18 10:15:05 -05:00
Danillo Souza
a07dd5650e fixing typo 2014-11-17 18:44:34 -05:00