Commit graph

1029 commits

Author SHA1 Message Date
vsopvsop
afb3334ed8 docs: Correct link of 'now' tpl func in release notes
When mentioning the commit for 'now' template function the previous line's github link is repeated unfortunately.
2017-02-28 21:06:48 +01:00
Keane Nguyen
396276aafa docs: Revise automated deployment tutorial
Update tutorial to reflect changes to Wercker website.
2017-02-27 20:31:38 +01:00
Bjørn Erik Pedersen
0a99168220 docs: Some minor release notes fixes 2017-02-27 11:21:29 +01:00
Bjørn Erik Pedersen
28198ce982 docs: Fix shortcode param in release notes 2017-02-27 11:16:19 +01:00
Bjørn Erik Pedersen
c9c889c198 docs: Add release notes for Hugo 0.19 2017-02-27 10:35:31 +01:00
Bjørn Erik Pedersen
eb572c8a18 docs: Add documentation for disableKinds
Fixes #3054
2017-02-26 21:51:53 +01:00
Cameron Moore
8d5132229f docs: Update RSS docs with rssLimit changes
Side effect: remove unnecessary XML templates from example blog site.

Fixes #3065
2017-02-26 21:47:05 +01:00
Bjørn Erik Pedersen
3631fd2f0e docs: Regenerate commands doc 2017-02-25 10:03:28 +01:00
Josh Archer
eaabecf586 docs: Adds 'Using _index.md' page
There has been confusion regarding the use of _index.md pages following
the shift to 'Everything is a Page' in Hugo v0.18:

https://discuss.gohugo.io/t/hugo-0-18-ignores-index-md-in-the-section/4896

This has lead to attempts at clarification:

https://discuss.gohugo.io/t/-index-md-pages-in-section-taxonomies-etc-are-not-rendered-using-single-html-template/5466

There is also an open issue regarding improving the docs on this topic:

https://github.com/spf13/hugo/issues/2827

This commit adds a dedicated page explaining how _index.md files fit
into Hugo's template hierarchy, what they can contain and how to render
content from them onto the respective list/terms/home page.

What this commit doesn't do is address confusion over former behaviour
of the 'index.md' files (note the lack of _). Instead it focuses on
clarifying the new behaviour in the hope of rendering the old moot.

Fixes #2827
2017-02-24 21:07:15 +01:00
Kiley Dorton
e21fdbae8d docs: Fix ambiguous typo in quickstart 2017-02-24 20:54:03 +01:00
digitalcraftsman
e9921ae4b2 docs: Mention Hugo's official twitter account 2017-02-23 22:05:38 +01:00
jacob-long
950d1aa1b3 docs: Add article to press.md + cleanup
Added article from gettingthingstech.com.
I also cleaned up some poorly-aligned entries near the top of markdown table
(though it doesn't affect the HTML output either way).
2017-02-23 21:11:25 +01:00
Félix Blanco
87acf292e5 docs: Add promotive.es to the showcase 2017-02-21 20:30:02 +01:00
Li-aung Yip
d3fb196067 docs: Improve documentation for menu rendering
Fixes #1393
2017-02-21 10:38:12 +01:00
Chase Adams
86e8dd62f0 all: Add org-mode support
Fixes #1483 
See #936
2017-02-21 08:46:03 +01:00
Anton Staaf
99fbc75e7a hugolib: Fix regression of .Truncated evaluation in manual summaries
This fixes the behavior of .Truncated that was introduced with commit
bef496b97e which was later broken.  The
desired behavior is that .Truncated would evaluate to false when there
was nothing after the user defined summary marker.

This also adds a simple unit test to ensure that this feature isn't
broken again.  The check for content after the user defined summary
marker is done on the raw content instead of the working copy because
some of the markup renderers add elements after the marker, making it
difficult to determine if there is actually any content.

The behavior (evaluating to false when there is no content, just
summary) is also now documented.
2017-02-19 10:11:49 +01:00
John Feminella
b2e3748a4e hugolib: Enhance .Param to permit arbitrarily nested parameter references
The Param method currently assumes that its argument is a single,
distinct, top-level key to look up in the Params map. This enhances the
Param method; it will now also attempt to see if the key can be
interpreted as a nested chain of keys to look up in Params.

Fixes #2598
2017-02-19 08:50:08 +01:00
Cameron Moore
10c13f5d79 hugolib: Make RSS item limit configurable
Add a new rssLimit site configuration option with default of 15.  Prior
to this fix, you could create your own RSS feed to override the default
limit of 15, but we still had a hardcoded limit of 50 items set in
`hugolib.renderRSS()`.

With this option in place, the `range first 15 .Data.Pages` logic is no
longer hardcoded into the embedded RSS template.

Because the size of the slice passed to the template is now limited to
rssLimit instead of 50, this commit is a breaking change for sites
with a custom RSS template that expects more than 15 items.

Fixes #3035
2017-02-17 19:53:08 +01:00
digitalcraftsman
e34af6ee30 docs: Add hugofy for atom to the tools section 2017-02-16 09:44:27 +01:00
Bjørn Erik Pedersen
a988d3cf36 docs: Remove the source relative links docs
See #3028
2017-02-13 16:35:05 +07:00
ITSecMedia
2ded3bf30f docs: Update www.bullion-investor.com/report/ in the showcase 2017-02-12 10:03:44 +01:00
John Feminella
298ebc37c2 hugolib: Add ability to sort by frontmatter parameters 2017-02-10 20:01:25 +07:00
Yizhe Xu
7a5cc3cfd7 docs: Add instructions for customized domain 2017-02-09 10:50:16 +01:00
Dundonian
3e5ad4aeeb docs: Update Bitbucket Hosting Tutorial 2017-02-05 21:55:18 +01:00
Pascal Aubort
9c97949513 docs: Add article to press section
Link blog post which describes how to use Cloud9 IDE to make a Hugo site and then deploy it to Google App Engine.
2017-02-05 21:53:14 +01:00
ominty
7fd88fb199 docs: Update link to blog post in community/press.md
changed link to german tutorial series as site structure has changed due to page update
2017-02-04 22:30:29 +01:00
Andrew
2af2ff3c1f docs: Add tuorial "How to use Google Firebase to host a Hugo site"
Aerobatic.io migrated their Bitbucket hosting plugin and no longer provide
a free tier with a custom domain.  This tutorial covers setting up Firebase
to host a Hugo site that was previously hosted on Aerobatic.
2017-02-04 22:26:10 +01:00
digitalcraftsman
dae6a4539f docs: Fix typo in templates/functions.md 2017-02-04 22:23:57 +01:00
Devin Schulz
24512fa82b docs: Add engineering.invisionapp.com to the showcase 2017-01-29 15:58:15 +01:00
Sebastian G
7241253c22 docs: Multilingual documentation for frontmatter params
Fixes #2990
2017-01-27 19:14:48 +01:00
ZaneDev
1e79900860 docs: Add netlify to the list of static hosting solutions
Netlify is a solid solution similar to surge and aerobatic and they have a great free plan and pro plan for open source projects.
2017-01-26 19:42:56 +01:00
Alan Orth
72cffed89b docs: Add picturingjordan.com to the showcase 2017-01-24 15:45:59 +01:00
Ardianta Pargo
91c569c7e5 docs: Add petanikode.com to the showcase 2017-01-22 14:10:55 +01:00
Wouter Groeneveld
d949c34af1 docs: Add Dokuwiki to hugo conversion tool
I've written a DokuWiki to hugo conversion tool in python to migrate my blog content to Hugo. I hope others will also benefit from it. Feel free to take a look and give some feedback.
2017-01-18 19:39:07 +01:00
digitalcraftsman
940c5d8bae docs: Add tumblr-to-hugo to tools section 2017-01-18 19:24:32 +01:00
digitalcraftsman
dc61d3b6b3 docs: Update author credits in GH pages tutorial 2017-01-15 20:08:34 +01:00
Gunnar Morling
3818d6967a docs: Update tutorial on GitHub Pages deployment
Now it describes the deployment via /docs folder and git worktree.
2017-01-15 19:50:20 +01:00
Leo Arias
24a286791f Add the instructions to install the snap 2017-01-06 18:55:25 +01:00
Mathias Biilmann
2989c38245 tpl: Add truncate template function
This commit adds a truncate template function for safely truncating text without
breaking words. The truncate function is HTML aware, so if the input text is a
template.HTML it will be truncated without leaving broken or unclosed HTML tags.

    {{ "this is a very long text" | truncate 10 " ..." }}
    {{ "With [Markdown](/markdown) inside." | markdownify | truncate 10 }}
2017-01-06 10:42:32 +01:00
Ryan Watters
e856f24129 docs: Update references to _index.md 2017-01-04 17:20:01 +01:00
Anthony Fok
49a840be83 docs: Add new article about Netlify's PR site preview
Written by @keybits and mentioned by @bep on Gitter
2017-01-04 01:17:36 -07:00
Daniel Lang
2127203ae3 Update documentation and test for sitemap template 2017-01-03 17:11:22 +01:00
digitalcraftsman
be39ae5e11 docs: Fix typo in overview/source-directory.md 2017-01-02 15:58:48 +01:00
Timo Litzius
2ece1b325b docs: Add heimatverein-niederjosbach.de to the showcase 2017-01-02 15:51:05 +01:00
Timo Litzius
433c03616b docs: Add dbzman-online.eu to the showcase 2017-01-02 15:44:31 +01:00
Bret Mogilefsky
0d330b0d5d docs: Fix typo in v0.18 release notes 2017-01-02 14:11:04 +01:00
Nishanth Shanmugham
cabc6b3186 tpl: Add now function
Add a now template function that returns the current time as time.Time.
Also, update related docs.
2017-01-01 02:50:46 +01:00
digitalcraftsman
707d3cf137 docs, tpl: Fix documentation of UniqueID
See #2861
2016-12-31 17:55:03 +01:00
Gertjan van den Burg
73c1e271f7 docs: Add HugoPhotoSwipe to the tools section
HugoPhotoSwipe is a command line tool to create and manage PhotoSwipe galleries with Hugo. It resizes images for responsive layouts in PhotoSwipe and generates the Markdown necessary for Hugo to create the gallery. I think this can be a useful tool for Hugo users.
2016-12-31 12:39:58 +01:00
Bjørn Erik Pedersen
e9e4fd90e4 docs: Add release notes for Hugo 0.18.1 2016-12-29 16:43:10 +01:00
Asif Mehedi
211d20a3c7 docs: Update GitLab depleyment in /themes/installing.md
Deployment to Gitlab fails if the theme folder is a git submodule.
2016-12-28 14:01:09 +01:00
digitalcraftsman
862f09babe docs: Add hugofy for VS Code to the tools section 2016-12-28 13:41:54 +01:00
Bjørn Erik Pedersen
e78dd3cd48 docs: Enable ToC for extras/shortcodes 2016-12-26 19:31:34 +01:00
Asif Mehedi
441476b6c5 docs: Convert code in multilingual.md to TOML
There was a mix of TOML and YAML in the first example config.
2016-12-22 17:19:10 +01:00
patrick
ec34ed0520 docs: Add neavey.net to the showcase. 2016-12-22 17:16:01 +01:00
Emily Huynh
a4fc20a12b docs: Fix typo in templates/blocks
Fixed typo in templates/blocks.md in the docs.
2016-12-22 17:05:48 +01:00
Akilan Elango
e7ff094d63 docs: Add details about binary names for setup on Windows
The tutorial for installing on windows didn't mention the exact name of the
hugo executable in windows which is generally hugo_<hugo-version>_windows_<arch>.exe.
The tutorial mentioned the windows executable's name as hugo.exe, which
can be confusing sometimes. So extra information has been added to
rename the executable to hugo.exe which would be easy to use.

Fixes #2656
2016-12-22 17:03:33 +01:00
Christian Mendoza
4845a13c9e docs: Update christianmendoza.me in the showcase 2016-12-21 18:52:08 +01:00
Bjørn Erik Pedersen
1eb079543f docs: Regenerate commands doc 2016-12-20 09:39:25 +01:00
Bjørn Erik Pedersen
09cc7915ed docs: Add new alias feature to release docs 2016-12-19 15:38:10 +01:00
Bjørn Erik Pedersen
4de808ae7c docs: Add 0.18 release notes 2016-12-19 14:42:01 +01:00
Ashutosh Gangwar
71aa797b27 docs: Fix broken link to Content Types 2016-12-16 11:10:14 +01:00
Brian Shumate
6fd4bfcae3 docs: Update layouts path name 2016-12-16 01:09:51 +01:00
Bjørn Erik Pedersen
79b2725ac4 docs: Improve documentation for block templates
Hopefully.

Fixes #2363
2016-12-15 22:02:21 +01:00
Cameron Moore
596bbea815 docs: Clarify single page template search path
Fixes #2791
2016-12-15 19:34:25 +01:00
Cameron Moore
26084ad198 docs: Fix pipe examples
Fixes #2787
2016-12-15 19:33:40 +01:00
Cameron Moore
fa09e20d9a docs: Fix Ref and RelRef syntax
Fixes #2793
2016-12-15 19:32:41 +01:00
Cameron Moore
2f0e81989a docs: Document partialCached func
Fixes #2779
2016-12-15 19:31:43 +01:00
Cameron Moore
9c2ea3691a docs: Add .Site.RegularPages docs
Fixes #2775
2016-12-15 11:15:42 +01:00
Cameron Moore
d332aa1606 docs: Update GitInfo usage docs 2016-12-15 11:15:15 +01:00
Cameron Moore
f8190777f2 docs: Cleanup Extras menu ordering 2016-12-15 11:15:15 +01:00
Cameron Moore
aecabfcd4f docs: Add Extras > GitInfo
Fixes #2670
2016-12-15 11:15:15 +01:00
madhead
e4ebe0d5bf docs: Fix querify example 2016-12-14 11:01:11 +01:00
Eugene Brodsky
c7f67dd63c docs: Clarify usage of archetypes provided by themes 2016-12-10 10:50:48 +01:00
Cameron Moore
b4404a9554 docs: Update File variables 2016-12-10 10:47:23 +01:00
Cipto Hadi
b4cbccaaf4 docs: Fix prev/next links in content section 2016-12-09 16:28:34 +01:00
digitalcraftsman
2236056672 docs: Fix linebreaks in templates/variables.md 2016-12-04 18:21:52 +01:00
digitalcraftsman
0f6c73cf2e tpl: Add sha256 template function
Fixes #2742
2016-12-04 15:03:52 +01:00
digitalcraftsman
01b8bc1b26 docs: Update description of querify 2016-12-03 20:23:59 +01:00
digitalcraftsman
0ba9fb9631 docs: Document querify template func
Closes #2733
2016-12-03 20:12:12 +01:00
Cameron Moore
971d1baf13 commands: Add noChmod option to disable perm sync
Includes updates to docs.

Fixes #2749
2016-11-30 08:35:30 +01:00
Victor Kropp
dbb0c1cfc9 hugolib: Add shortcode for Instagram 2016-11-23 20:28:42 +01:00
digitalcraftsman
001e2bbe8a docs: Set correct default archetype directory in overview
Fixes #2719.
2016-11-23 19:53:24 +01:00
Bjørn Erik Pedersen
a5b3b07657 docs: Add Pages to variables section
And some other minor doc fixes.

Closes #2297
Closes #2649
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
6c0ecc2d28 docs: Add release notes about node to page
Updates #2297
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
e29f6fe527 docs: Add sections on node now being a page
Updates #2297
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
aafbd3b4bf docs: Revise docs to reflect that Node is gone
Updates #2297
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
ae1de7abb1 docs: Make the tools content page a section page
Because it is the right solution and it the avoids naming conflict with section vs page.

Updates #2297
2016-11-22 09:57:03 +01:00
Bjørn Erik Pedersen
65f803e1fa docs: Rename RSSlink to RSSLink
The former will be deprecated.
2016-11-19 12:00:25 +01:00
balaramadurai
7b8a09d5f9 docs: Add balaramadurai.net to the showcase 2016-11-18 17:41:18 +01:00
Tristan Rice
a49f838cd0 tpl: Add imageConfig function
Add imageConfig function which calls image.DecodeConfig and returns the height, width and color mode of the image. (#2677)

This allows for more advanced image shortcodes and templates such as those required by AMP.

layouts/shortcodes/amp-img.html
```
{{ $src := .Get "src" }}
{{ $config := imageConfig (printf "/static/%s" $src) }}

<amp-img src="{{$src}}"
           height="{{$config.Height}}"
           width="{{$config.Width}}"
           layout="responsive">
</amp-img>
```
2016-11-16 13:00:45 +01:00
Rafael Monteiro
bb36d57be5 docs: Fix typos in extras/scratch.md 2016-11-13 13:45:31 +01:00
Ahmed Zetao Yang
52e2fd27f8 docs: Add article by Zetao Yang 2016-11-06 14:33:24 +01:00
digitalcraftsman
8dace9ad6d docs: Update roadmap
Closes #2666
2016-11-04 20:18:13 +01:00
Adrien Poupin
774f13bd5d doc: Add a "Deployment with rsync" tutorial page
This is kind of a generic process and not so difficult. It seems important to me that it should be documented.
2016-11-04 17:00:24 +01:00
Bjørn Erik Pedersen
c9be931ebe docs: Remove non-showcase Hugo sites
I.e. sites with no mention of Hugo or hugo etc. in the HTML source.

Fixes #2655
2016-11-02 19:12:58 +01:00
Bjørn Erik Pedersen
cda3b36fe2 Revert "docs: Add www.bullion-investor.com to the showcase gallery"
No hugo generator tag, probably not a Hugo a site, certainly not a showcase.

This reverts commit b5bc74ca46.
2016-10-31 22:32:53 +01:00
ITSecMedia
b5bc74ca46 docs: Add www.bullion-investor.com to the showcase gallery 2016-10-29 14:21:25 +02:00
digitalcraftsman
01cfcce6c0 docs: Add two articles written by Hash Borgir 2016-10-29 14:02:14 +02:00
Sam Klein
c936b6c89a docs: Fix punctuation in content.md
- removed comma on line 16 to avoid confusion between clauses
- added period to line 24 for consistency
- clarified "read on" on line 30 to follow style above it while
  also verbally writing what the author seems to intend
- removed "You probably know what to do." on line 30 due to wordiness
  that could lead to confusion and a drag in reading speed
2016-10-24 23:56:39 +02:00