Commit graph

1666 commits

Author SHA1 Message Date
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
bep 55fcd2f30f Shortcode rewrite, take 2
This commit contains a restructuring and partial rewrite of the shortcode handling.

Prior to this commit rendering of the page content was mingled with handling of the shortcodes. This led to several oddities.

The new flow is:

1. Shortcodes are extracted from page and replaced with placeholders.
2. Shortcodes are processed and rendered
3. Page is processed
4. The placeholders are replaced with the rendered shortcodes

The handling of summaries is also made simpler by this.

This commit also introduces some other chenges:

1. distinction between shortcodes that need further processing and those who do not:

* `{{< >}}`: Typically raw HTML. Will not be processed.
* `{{% %}}`: Will be processed by the page's markup engine (Markdown or (infuture) Asciidoctor)

The above also involves a new shortcode-parser, with lexical scanning inspired by Rob Pike's talk called "Lexical Scanning in Go",
which should be easier to understand, give better error messages and perform better.

2. If you want to exclude a shortcode from being processed (for documentation etc.), the inner part of the shorcode must be commented out, i.e. `{{%/* movie 47238zzb */%}}`. See the updated shortcode section in the documentation for further examples.

The new parser supports nested shortcodes. This isn't new, but has two related design choices worth mentioning:

* The shortcodes will be rendered individually, so If both `{{< >}}` and `{{% %}}` are used in the nested hierarchy, one will be passed through the page's markdown processor, the other not.
* To avoid potential costly overhead of always looking far ahead for a possible closing tag, this implementation looks at the template itself, and is branded as a container with inner content if it contains a reference to `.Inner`

Fixes #565
Fixes #480
Fixes #461

And probably some others.
2014-11-17 18:32:06 -05:00
Michael Henderson 6bf6a810ee Update creating-a-new-theme.md 2014-11-13 22:44:31 -05:00
Michael Henderson 88881de2d4 Update creating-a-new-theme.md 2014-11-13 22:44:31 -05:00
Michael Henderson e9917bfe16 Update creating-a-new-theme.md
Update heading levels to confirm to the other tutorials. Create a similar front-matter using YAML, since I couldn't figure out how to get the menu:main:parent working as TOML.
2014-11-13 22:44:30 -05:00
Ryan Kimber fc20d0b444 Fixed launchcode5.md description 2014-11-13 22:08:30 -05:00
Ryan Kimber 15dae3ccde Create launchcode5.md 2014-11-13 22:08:29 -05:00
bep 3cec04e0d2 Add Git directory deployment flow to tutorial 2014-11-13 12:33:14 -05:00
Mike Dillon 2060031c1f Fix sourceLink for Hugo 2014-11-01 23:39:49 -04:00
Michael Henderson d036ddf237 Create creating-a-new-theme.md 2014-11-01 23:12:01 -04:00
Justin Calleja 11ddc308e3 Fix for issue 583 2014-11-01 23:10:52 -04:00
Kartik Singhal 6c238e140d Fix broken link 2014-11-01 23:08:48 -04:00
Kartik Singhal 649a7d2bbf Minor doc corrections 2014-11-01 23:03:29 -04:00
Joel Scoble d4ed59198a added note about pygment example code and markdown processing, updated example 2014-11-01 22:58:44 -04:00
Tatsushi Demachi 5e28606b84 Add sort and grouping functions for publish date and param of Page
`GroupBy` is modified to allow it to receive a method name argument for
example `Type` as its first argument. It is only allowed to call with
a method which takes no arguments and returns a result or a pair of
a result and an error.

The functions discussed at #443 are also added

- `ByPublishDate`: Order contents by `PublishDate` front matter variable
- `GroupByPublishDate(format, order)`: Group contents by `PublishDate`
  front matter variable formatted in string like `GroupByDate`
- `GroupByParam(key, order)`: Group contents by `Param` front matter
  variable specified by `key` argument
- `GroupByParamDate(key, format, order)`: Group contents by `Param`
  front matter variable specified by `key` argument and formatted in
  string like `GroupByDate`. It's effective against `time.Time` type
  front matter variable
2014-11-01 22:41:04 -04:00
Joel Scoble 73ec09258b update summary doc 2014-11-01 22:27:54 -04:00
Joel Scoble 9e029fe412 #463 add summary.md page 2014-11-01 22:27:47 -04:00
Will Stevens 1d4dde7ac3 added docs for 'intersect' and 'in' template functions 2014-10-15 12:30:10 -04:00
Anthony Fok ca7007bf26 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-15 12:18:20 -04:00
bep 953cad6cbd Document manual breakpoint of .Summary
The use of <!--more--> to set the breakpoint for the generated page summary is mentioned in a release note, but not in the doc itself.

Very useful - and it leaves the formatting in place.
2014-10-15 12:15:59 -04:00
Austin Ziegler e68e7ef96f Configure footnote rendering.
- The config file can provide FootnoteAnchorPrefix, which will be used
  by blackfriday when rendering to HTML. A value of `q:` has the effect
  of making the anchor for a footnote `[^footie]` be `fn:q:footie`. The
  default is `""`.

- The config file can provide FootnoteReturnLinkContents, which will be
  used by blackfriday when rendering to HTML. A value of `^` has the
  effect of making the return link be `^` instead of `[return]`.
2014-10-07 16:43:33 -04:00
Jorin Vogel eeaf343a14 Mention .Params and .Page variables in shortcode docs. Also highlight variables. 2014-10-02 13:53:36 -04:00
Aurelius Prochazka c739ec228c Removed text from code block. 2014-10-02 13:45:47 -04:00
Kartik Singhal 879e90dca7 Switch to new hompage 2014-10-02 13:39:59 -04:00
Austin Ziegler def79376c4 Make taxonomy documentation match the example. 2014-09-24 14:56:53 -04:00
Kartik Singhal 3060307085 Make highlight.js example clearer
Provide the missing step to actually use the library. Should be helpful for a newbie.
2014-09-24 14:56:44 -04:00
Alex Dunn 4e4ea9583f instructions for Homebrew installation
updated installation page of documentation, and changed "Download" button on index.html to scroll to bottom where multiple installation options are featured

getting the scrolldown to work required removing the fixed positioning on #action and on the footer
2014-09-22 21:51:19 -04:00
spf13 bf980bc138 switching website to gohugo.io & adding links to discuss 2014-09-18 21:22:04 -04:00
rybi 1a0dc0b936 Update urls.md
Corrected the --uglyUrls flag, wouldn't work if lowercase.
2014-09-18 13:06:02 -04:00
Alex Dunn 275e1c0d23 more examples and explanation of go templating
Emphasizing to people (like me) who aren't familiar with Go that just because something's not mentioned in the Hugo docs doesn't mean it's not possible
2014-09-11 17:22:08 -04:00
Daniel Fairhead 012a473e27 added "eq" function to docs. 2014-09-11 17:02:20 -04:00
Tim Dumol b336abcf81 Fix typo in Archetypes documentation.
Archetype was spelled archtype in one of the headers.
2014-09-08 11:54:40 -04:00
Anthony Fok 5dd3eaabee 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-08 11:41:10 -04:00
spf13 05102f1b79 Fixing typo in ordering.md fixed #401 2014-09-02 17:09:56 -04:00
spf13 b4d3195f65 Adding V0.12 release notes 2014-09-01 10:00:45 -04:00
Anthony Fok a6022293af Minor proofreading corrections to Hugo docs 2014-09-01 08:19:40 -04:00
Anthony Fok c1b9e8d54b quickstart.md: Put long options inside backticks
Also minor adjustment to blank lines.
2014-08-30 01:16:18 -04:00
spf13 93addfcbee Adding documentation about 'where' and cleaning up docs around first. 2014-08-30 00:57:38 -04:00
spf13 0ce4ec1edb Added more examples and cleaned up the GroupBy functionality documentation 2014-08-30 00:21:47 -04:00
spf13 bb02a14b1e Adding a page listing the different methods available to Taxonomies. 2014-08-29 23:42:26 -04:00
spf13 ba8f652acc More taxonomy examples in templates. 2014-08-29 23:41:53 -04:00
spf13 6f9f93f34b Fixing the taxonomy example. Fixed #318. 2014-08-29 23:39:55 -04:00
Jakub Turski d3646aaac0 Be more specific about .Params content
I'm not sure whether this is *always* the case, but it's definitely have been my experience so far. :)
2014-08-28 13:04:00 -04:00
Jakub Turski 7de320920c Shortcodes are content files specific.
This fixes spf13/hugo#440.
2014-08-28 12:59:52 -04:00
Tatsushi Demachi 6f9db4a784 Add document about page grouping functions 2014-08-28 12:56:32 -04:00
spf13 828401cbe6 More press additions 2014-08-27 11:47:12 -04:00
spf13 954498803d Added ucsb to showcase 2014-08-26 14:37:12 -04:00
spf13 dcda66dfab More Press 2014-08-26 14:36:38 -04:00
spf13 4a91b8c7fd fixed #389 . Added alias for missing page. 2014-08-26 13:16:45 -04:00
spf13 1c1615d794 Adding a bunch of new sites to the showcase 2014-08-26 12:27:25 -04:00
spf13 c9a6b2b93c Adding a bunch of new press to the Press page. 2014-08-26 12:26:29 -04:00
spf13 294222ac74 Fixing a broken link in the docs 2014-08-25 14:02:39 -04:00
Chase Adams 867683e473 Add link for learning more about static directory 2014-08-20 14:23:17 -04:00
spf13 04d412ed16 Fixed showcase image paths 2014-08-20 11:17:38 -04:00
spf13 aae1ff3c92 Adding IsNode & IsPage functions to Page & Node 2014-08-19 21:27:13 -04:00
Franklin Wise 27c0ec3163 Added a note after the script adding potential issues per @franklinwise's feedback 2014-08-18 11:58:49 -04:00
Rahul Bansal 6e15f652bd Added yaml menu example
Added yaml menu example, matching with existing toml example. Also added link to sitewide config page.
2014-08-18 11:30:00 -04:00
Rahul Bansal 5d8ac54f73 Config changes and Live Reload
I noticed that config file changes do not work with Live Reload feature. This may be "fixed" in future but for now adding a note might avoid confusion.
2014-08-18 11:28:42 -04:00
Roberto Dip 09115a9623 Fix #394 - Docs: add a missing link to the livereload page in the intro 2014-08-18 11:24:53 -04:00
Franklin Wise e9b47da081 hugo builds no site if there are only drafts
if you run:
hugo
and all of your posts are drafts, no site gets build.
2014-08-18 11:21:45 -04:00
spf13 3e9fc47ad2 Adding more press 2014-08-10 00:17:36 -04:00
David Kebler cbb29795c3 Docs-removed bullet and broken link for catagetories. Included category text in bullet for taxonomies 2014-08-09 23:31:28 -04:00
Nate Finch 1778f28c87 remove extraneous "Because" 2014-08-06 05:39:58 -04:00
Nate Finch f556cb4414 update docs for permalinks with all fields
List all the fields and what they mean, based on hugolib/permalinks.go
2014-08-06 00:05:40 -04:00
Nate Finch 29c45dd690 make type-or-section more obvious
It took me a long time to realize that /layouts/TYPE or SECTION/LAYOUT.html  was supposed to be a single URL and not two urls (/layouts/TYPE) or (SECTION/LAYOUT.html) ... putting in the hyphens I think makes it much more clear it's all one URL, and only the middle part is an either-or.
2014-08-06 00:05:05 -04:00
GraemeCaldwell d8b78c3da2 Update press.md 2014-08-05 17:19:56 +01:00
Gina White 3eb480a62f fix link to template primer 2014-06-30 15:20:03 -04:00
Maarten Everts b76719744d taxonomies -> Taxonomies 2014-06-30 15:19:28 -04:00
Rolando Pereira 836b1800f9 Fix minor typo in file docs/content/templates/overview.md 2014-06-30 15:18:46 -04:00
Gour 0e57e32f54 do not use angle brackets in hyperlink labels 2014-06-30 15:16:30 -04:00
Michael Whatcott 406233f052 Included instructions for omitting disqus comments on localhost. 2014-06-30 14:55:42 -04:00
jesper-mortensen 86c3de4be1 Fix #263, document HTML comments & IE conditionals 2014-06-30 14:51:30 -04:00
spf13 b2b7ba4243 fixing typo in docs 2014-06-30 14:49:24 -04:00
spf13 c297d7451f Adding 'partial' template function to add theme / local awareness to the partials directory. 2014-06-06 16:15:19 -04:00
Abe Pazos 7b7ce11787 Add empty line to correctly render a list 2014-06-03 15:09:53 -04:00
spf13 05875153bc Converting front matter to YAML 2014-05-29 18:45:22 -04:00
spf13 012823a32a Update menu documentation to be accurate 2014-05-29 18:45:21 -04:00
spf13 0c2544608c Add future details to documentation 2014-05-29 01:02:43 -04:00
Dan Hersam d65061dffb Adding TechMadePlain to showcase
Thanks to Hugo I get to write all my posts in Markdown.
2014-05-28 17:58:31 -04:00
Rolando Pereira 79767f5617 Fix links to GitHub repo for spencerlyon2/hugo_gh_blog
Hello,

The `github_pages_blog.md` tutorial mentioned links to the git repository of "spencerlyon2/hugo_gh_blog" however it was linking to the page itself (i.e. http://spencerlyon2.github.io/hugo_gh_blog ).

This commit replace those links with links to https://github.com/spencerlyon2/hugo_gh_blog
2014-05-28 17:58:11 -04:00
spf13 2a44ca543b More doc site improvements. Added documentation's new layout 2014-05-28 01:37:33 -04:00
spf13 a87f171bd4 Updating / Rewriting / Adding all of the documentation in preparation for the next release 2014-05-27 18:32:57 -04:00
spf13 b520f8852d Switching docs highlighting to highlight.js .. Docs build super fast again! 2014-05-15 09:58:55 -04:00
spf13 b198cb26ba Renaming indexes to taxonomies in docs 2014-05-15 09:57:36 -04:00
LK4D4 2194cc77de Add pygmentsstyle and pygmentsuseclasses options
Fixes #204

Conflicts:
	commands/hugo.go
2014-05-09 23:20:11 -04:00
Vincent Batoufflet 5df0cf7eca Add Sitemap documentation content 2014-05-09 23:11:48 -04:00
Marc Liyanage 4e0208d448 Doc fix: replace "hugolibs" with "hugo" in "contributing" page, fixes #271. 2014-05-09 11:36:16 -04:00
spf13 ec4b152678 Fixing broken link. Fixed #278. 2014-05-09 11:32:06 -04:00
spf13 9b192e6793 Adding more information about client side highlighting 2014-05-09 00:03:42 -04:00
Dave Cottlehuber bc9f69e7c5 Add client-side syntax highlighting example 2014-05-08 23:45:33 -04:00
Ciaran Downey 5581e33a34 Update broken localhost link 2014-04-26 23:08:39 -06:00
spf13 11fe227b9e Implementing new menu system in the docs site 2014-04-23 03:00:11 -04:00
spf13 be37c0b37a Adding more articles to press page. 2014-04-08 21:41:01 -04:00
Michael D. Johas Teener 4161d542ce Misc doc fixes
* Pygments links and requirements for installation.
  * Fix to link to additional template functions in release notes for
v0.10
2014-04-08 11:30:11 -04:00
spf13 d1c500c124 Adding Press page to hugo docs 2014-04-07 23:47:21 -04:00
ojan a6170154cf add: yslow-rules showcase 2014-04-07 11:44:51 -04:00
Stephen Eglen a01056b98a typos in mathjax.md
Fix some typos.
2014-03-31 14:31:39 -04:00
Spencer Lyon a7ca39ccd7 ENH: added tutorial for hosting a blog on github pages 2014-03-31 14:26:58 -04:00
Zach Chadwick 2e4158b0b4 added appliance.cloudshark.org to showcase
also cleaned up thumbnail view to not show source link if unavailable
2014-03-31 13:35:15 -04:00
spf13 e50b9d8ac1 Adding support for logging & verbose logging. Consolidation of error handling. Integration of jWalterWeatherman library. Fixed #137 2014-03-31 13:23:34 -04:00
Spencer Lyon 2fa3761ec9 DOC: added tutorial for using MathJax with Hugo 2014-03-24 15:11:54 -04:00
Nate Finch c02a02070f change golang to go 2014-03-24 14:34:41 -04:00
spf13 51b078a703 Homepage update. New Logo. Minor site updates. 2014-03-20 21:51:14 -04:00
Alexandre Normand 85c04ca2f3 Add Tutorial With Steps to Migrate from Jekyll. 2014-03-13 12:23:33 +01:00
Alexandre Normand 17fdf7d604 Add www.heyitsalex.net to Community Showcase. 2014-03-13 12:02:14 +01:00
Alex Dunn 38131837ba clearer pseudo command in quickstart doc
- previously it was ambiguous between the actual Step 1 and the "step 1" of the steps *within* Step 2 ("Clone into the hugo repository")

- also fixed a typo I guess
2014-03-13 11:59:36 +01:00
Ruben d5c58b457f Order ByTitle and ByLinkTitle added
Added documentation for new order possibilities
2014-03-13 11:39:19 +01:00
spf13 0447c7598b Adding the right date for the release of 0.10 2014-03-01 12:16:36 -05:00
Kieran Healy 732b5d42b2 Add Kieran Healy's website. 2014-02-28 11:50:19 -05:00
spf13 ae954d5165 updating the intro page 2014-02-28 11:41:47 -05:00
spf13 64572d2d60 Shortcode cleanup. Added a ton of tests. Much more flexible with input. Doesn't crash with bad input. Fixed #193
Also added the .Get function to short codes and documentation for that function.
2014-02-25 23:57:31 -05:00
spf13 8fe78f6ff5 A bunch of small documentation changes 2014-02-21 09:48:37 -05:00
spf13 de05a0d942 Adding documentation on Pretty Urls 2014-02-20 19:04:29 -05:00
spf13 e74d1b8607 Adding documentation on Table of Contents functionality 2014-02-20 19:04:08 -05:00
spf13 30e804eee5 Adding an introduction to Hugo 2014-02-20 19:03:37 -05:00
spf13 5cff3e6219 Adding Else If example 2014-02-19 09:24:04 -05:00
spf13 1bead0ed7a Adding Documentation on using Syntax Highlighting 2014-02-18 18:35:45 -05:00
spf13 56dfdfe86c Adding Documentation on Hugo Template Functions 2014-02-18 18:35:27 -05:00
spf13 bf6407759b Minor Docs Tweaks 2014-02-18 18:35:03 -05:00
spf13 8008675983 Adding Go Template Tutorial 2014-02-18 18:34:51 -05:00
spf13 dca7a90181 Updating Release Notes and Roadmap 2014-02-18 18:34:29 -05:00
Ant Zucaro 24ffe04360 Add Ant Zucaro's showcase.
A photography-oriented blog using Foundation 5 by Zurb. Responsive
layout with padded large and full-width small views. A sample
"polaroid" shortcode is included for image showcases, as is a
"header" image directive in the frontmatter.
2014-02-05 11:46:53 -05:00
Luke Holder 5cfb690e31 Fix docs error with json comma 2014-02-03 13:50:28 -05:00
spf13 18b9948f1e Using table of contents within the documentation. 2014-01-28 23:29:05 -05:00
spf13 f82c645b33 fixing 178. 2014-01-27 17:20:35 -05:00
spf13 4f1807c7a7 Replacing hall of fame with showcase. (new type, content driven, thumbnails, etc) 2014-01-22 17:16:09 -05:00
Andrew Codispoti 0e013b5291 add andrewcodispoti.com to hall-of-fame 2014-01-22 15:24:11 -05:00
spf13 50a7f97a62 Updating page variable documentation (for templates). 2014-01-21 20:07:55 -05:00
Brandon Philips f8243624e4 feat(docs/hall-of-fame): add ifup
Add me! Thanks for hugo, working great.
2014-01-13 10:06:32 -05:00
Phil Pennock 438c219892 Add canonifyurls config option.
Be able to inhibit AbsURL canonicalization of content, on a site
configuration basis. Advantages of being able to inhibit this include
making it easier to rendering on other hostnames, and being able to
include resources on http or https depending on how this page was
retrieved, avoiding mixed-mode client complaints without adding latency
for plain http.
2014-01-13 10:06:12 -05:00
spf13 2ff108fcb7 Add highlighting of code in documentation and clean up a bunch of the docs. 2014-01-10 21:29:58 -05:00
Dana Woodman b82baa285b Adding chimeraarts.org to hall-of-fame
I've added the website for the makerspace I founded into the hall of fame list as an example of what you can do with Hugo.

It's a work in progress (like everything) but should show people another example of using Hugo in the real world.

Hugo has made it much easier to update our website content without needing to use bloated or expensive tools.

Thanks!
2013-12-31 22:45:47 -05:00
spf13 34ac562ce4 Added documentation on ordering indexes, content and content within indexes 2013-12-20 18:11:49 -05:00
Ruben c7083a5d36 Section in example was wrong for happiness.md 2013-12-16 17:43:53 -05:00
spf13 a10519643d Adding better contribution guidelines from the read me to the contribution page. 2013-12-10 22:34:13 -05:00
spf13 dd574628a0 Adding community section to the documentation 2013-12-10 22:34:13 -05:00
spf13 f09505a657 Adding example short codes to the documentation 2013-12-10 22:34:13 -05:00
David Gay ba5dadff79 Typo fix in docs.
Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-23 20:41:54 -08:00
Valeri Karpov 32d9345bba Fix a minor typo in types.md
Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-23 08:49:08 -08:00
Javed Khan b351731f72 quickstart docs - fix flag needs arg error
Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-23 08:47:25 -08:00
Phil Pennock e425226a28 Documentation updates, mostly for my bits
* extras/permalinks.md added, weighted to third in the extras menu
* examples added to layout/go-templates.md, using `.Site.Params`
* mention `.Site.Params` in layout/variables.md
* update meta/release-notes.md to mention `first` and the permalinks
* update overview/configuration.md to use reserved-for-documentation
  domains and with another example, nudging towards permalinks and site
  parameters, with three different data-types shown for the latter

Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-11-18 15:51:31 -08:00
spf13 4f335f0c7f Updated release notes. 2013-11-15 23:47:53 -05:00
spf13 445b7d23fb Updating docs to include ‘first’ functionality for the homepage 2013-11-15 21:45:52 -05:00
Øyvind Skaar adc559b09f minor documentation fix 2013-11-07 19:47:42 +01:00
spf13 226bc8f59f Updated release notes 2013-11-05 00:24:04 -05:00
spf13 1d0d280e20 Addition of an indexes section to the docs. Updated most of the existing index content. 2013-10-31 09:51:13 -04:00
spf13 90355eec79 Big visual overhaul of the docs. Docs now using indexes for all menu generation. 2013-10-26 02:18:14 -04:00
spf13 5003f7f7af Docs menu now powered by indexes.. converting some of the content to use this. 2013-10-25 18:42:46 -04:00
spf13 9388f23606 Adding support for linkTitles 2013-10-25 18:37:53 -04:00
spf13 678ddef46a Adding a quick start guide to hugo docs 2013-10-17 22:53:04 -04:00
Noah Campbell 9500ec1b6b Refactor layout selection code
The render code path would use a fallback if there was an exception.
This change instead relies on explicit declaration of the layout to use
and includes a check to see if the layout indeed exists before
attempting to render it.
2013-10-08 18:44:15 +02:00
Noah Campbell 197aacb647 Add support for Relative Permalinks 2013-10-08 18:42:03 +02:00
spf13 8efb90ebd5 Updating usage documentation to new interface 2013-09-30 22:39:06 -04:00
Kyle Mahan aa9b9d596e minor documentation cleanup.
- changed it's -> its where appropriate.
- added post/ parent directory above happy/ to the organization examples

Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-09-29 19:50:25 -07:00
Noah Campbell c75da346e1 Fix alias documentation.
Fixes #79
2013-09-13 16:06:39 -07:00
Noah Campbell d4d9da9f3a Remove page module dependence on opening files
The site is responsible for reading files, page only operates on
buffers.
2013-09-04 19:36:06 -07:00
Daniel Alan Miller 71678a7183 Adding .Summary to page variables
Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-08-29 10:08:03 -07:00
Ross Lawley 7b1f0960e3 Add 404.html for gh-pages
Signed-off-by: Noah Campbell <noahcampbell@gmail.com>
2013-08-23 16:38:35 -07:00
Steve Francia 35b35a7004 Merge pull request #51 from cabello/patch-3
Remove extra quotes from meta data
2013-08-20 20:54:51 -07:00
Steve Francia 6f424175bf Merge pull request #50 from cabello/patch-2
Check .Prev and .Next pointers before using it
2013-08-20 20:54:31 -07:00
Danilo Cabello 8415c5e6c7 Remove extra quotes from meta data 2013-08-20 13:52:51 -04:00
Danilo Cabello acd5ea0e75 Check .Prev and .Next pointers before using it 2013-08-20 12:13:27 -04:00
Danilo Cabello 8058abd707 Fix broken link to Index page 2013-08-20 11:56:55 -04:00
spf13 8c0ab4def1 Complete overhaul of the docs 2013-08-17 21:54:39 -04:00
VonC 9308cd6a7a Clarify uglyurls flag.
Mention more clearly that, for generating `/filename.html`, you need to
set the `uglyurls` flag to `true`.
2013-08-14 16:47:17 +02:00
spf13 0233708907 Started new release notes, added nitro step for aliases 2013-08-10 15:44:22 +01:00
spf13 d5518c0966 Adding support for aliases (redirects) 2013-08-10 15:35:34 +01:00
Ross Lawley e2a28114d1 Add redirect to page parameters and redirects example 2013-08-09 21:57:22 +01:00
Steve Francia 4f17ad69a7 Merge pull request #22 from nsabine/master
Added examples to indexes.md
2013-08-09 02:16:10 -07:00
Nick Sabine a8b3e1537f Added examples to indexes.md 2013-08-09 00:10:35 -04:00
Duncan Beevers 04a0dbbf73 Added .Content variable to docs 2013-08-08 16:13:03 -07:00
Hideo Hattori 78afe8d344 update document for content directory 2013-08-06 03:14:40 +09:00
Gergely Imreh f31ec3c280 Fix example in docs that wouldn't work in practice
The pflag package used in hugo has to use the "=" sign
for double dash options such as --source. Thus the original
example `--source ~/mysite` is already incorrect. Adding
the = sign though woul not fix things in this case, since
`--source=~/mysite` does not get resolved to /home/username/mysite,
but looks for the ./~/mysite directory within the current directory.

To resolve this, either the directory name has to be changed in
the docs not to use the "~" sign, or have to change to use the
single dash version of the command line flag. The latter seems
to be more in line with the rest of the example.

Leaving `--watch` as a double dash option to minimize the change,
though it could be either way, since the follow up example uses
the single dash version of both.
2013-08-05 21:45:01 +08:00
spf13 6efbd93a38 Updating a bunch of the docs 2013-08-03 03:30:34 -04:00
spf13 def5f10183 Including documentation on indexes 2013-08-03 03:29:49 -04:00
Sebastian Müller 4efdb90943 Fix JSON syntax error in example configuration 2013-08-01 20:52:00 +02:00
spf13 16b1f284ca Improving installation instructions 2013-07-24 11:43:23 -04:00
spf13 627cf26571 Adding proper command line option parsing 2013-07-19 00:38:24 -07:00
spf13 dcd8ff716a Adding better source build instructions 2013-07-18 22:30:55 -07:00
spf13 8d50dd9160 fixing typo in config readme 2013-07-11 23:29:14 -04:00
spf13 75a2e6d4e8 Now support for config files as yaml, json or toml 2013-07-11 22:04:57 -04:00
tycho garen 4951ff998c rst: fixing rst output processing 2013-07-09 08:16:29 -04:00
spf13 d2a6267ad7 Adding support for TOML, updating documentation 2013-07-08 22:23:54 -04:00
spf13 3c80cd323c YAML support similar to jekyll (start and end with '---') 2013-07-08 17:57:01 -04:00
tycho garen d0ff31269a minor: correcting example 2013-07-07 11:59:19 -04:00
tycho garen f851c4162b fix: changing terminal yaml line, generalizing forematter splitting 2013-07-07 10:01:53 -04:00
tycho garen b024454ea9 fixes: returning json parsing, error messages, yaml header offsets 2013-07-07 01:03:12 -04:00
tycho garen 6c42d3d490 fix: parsing of yaml forematter 2013-07-06 23:37:47 -04:00
tycho garen 431fa0e2d7 changing to suport yaml rather than json and adding optional restructuredtext support 2013-07-06 22:48:12 -04:00
tycho garen a7f5f97bc2 sanity: move from json to yaml 2013-07-06 22:32:50 -04:00
Steve Francia 77d142ba17 fixing typos 2013-07-05 00:37:59 -04:00
Steve Francia 0d63bf00c3 better install instructions and fixing usage typo 2013-07-05 00:35:11 -04:00
spf13 3ec920ac0f adding better install directions 2013-07-04 13:03:16 -04:00
spf13 6e16449e5f adding hugo 2013-07-04 11:32:55 -04:00