github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-12-13 07:55:52 -05:00
Code Issues Projects Releases Packages Wiki Activity
1662 commits 140 branches 302 tags 202 MiB
Commit graph

600 commits

Author SHA1 Message Date
Bjørn Erik Pedersen
2805a6f80e Also rename readDir in docs shortcode 2015-08-07 14:55:53 +02:00
Bjørn Erik Pedersen
cea82842f0 Rename ReadDir to readDir 
To make it consistent with the other template funcs.
 2015-08-07 14:33:48 +02:00
Anthony Fok
5b19a26556 docs: Extend documentation on Blackfriday options 
Especially to spell out how the `latexDashes` flag
changes the behavior of smart dashes
 2015-08-05 16:24:03 -06:00
Anthony Fok
4a2eda49cd Add option to disable Blackfriday Smartypants 
Can be used in site config or per page front matter:

```
[blackfriday]
smartypants = false
```
 2015-08-04 21:42:32 +02:00
Anthony Fok
eb519afefd docs: Fix typos 2015-08-04 13:01:25 -06:00
Anthony Fok
ab8e189a2a docs: Bolden the blackfriday flags to make them stand out 
And other minor HTML/CSS tweaks.
 2015-08-04 12:34:47 -06:00
Anthony Fok
5505ac0d72 doc: Strip trailing whitespace; other revisions 
Make some random and non-comprehensive changes to the
template functions documentation to make them more
consistent.
 2015-08-04 12:00:08 -06:00
Anthony Fok
f2ab0b2608 Improve formatting of Hugo command descriptions 
Trying to make them look good both in the terminal (`hugo help [command]`)
and in the web browser (http://gohugo.io/commands/).  :-)
 2015-08-04 03:19:57 -06:00
Marek Janda
4bed69629e Add map support to scratch 2015-08-02 17:23:36 +02:00
Anthony Fok
211b757fee [Docs] Add <br> to an extra-long title in the Press page 2015-08-01 11:38:58 -06:00
Bjørn Erik Pedersen
738f9561ab docs: add netlify article to press section 2015-07-31 13:43:45 +02:00
Russell Oliver
81e69c416d Add ReadDir function to list local files. 
Includes documentation.
 2015-07-25 21:56:38 +02:00
Sam Debruyn
6674189bc2 The guide is updated to fit the current Wercker interface and configurations. 
Wercker changed its interface and default infrastructure (Docker).
 2015-07-24 14:35:39 +02:00
Bjørn Erik Pedersen
027abcfbb9 docs: fix prev in highlightling 2015-07-24 11:31:26 +02:00
Szymon Katra
9c8ce0d935 Added szymonkatra.github.io site to showcase 2015-07-24 11:26:24 +02:00
Scott C Wilson
cdefb5a027 Fix links to Ace and Amber pages 2015-07-24 11:22:05 +02:00
Scott C Wilson
de38524cd1 Add scottcwilson.github.io to showcase site 2015-07-24 11:21:56 +02:00
Bjørn Erik Pedersen
47e65c4acd docs: Rename dynamic content to data-driven content 
Fixes #925
 2015-07-23 12:54:58 +02:00
Scott C Wilson
dec9749bbc Document Amber templates 
Fixes #1064
 2015-07-20 15:28:20 +02:00
Christopher Eliot
7f1bcd89b2 Fix link to front matter 
added leading backslash, changing [front matter](content/front-matter) to [front matter](/content/front-matter)
 2015-07-19 19:41:20 +02:00
Clam-
85f4935dec Fix unclear RSS template docs 
The documentation for the RSS templating is a little unclear.
http://gohugo.io/templates/rss/

Some users may attempt to look for a ```__internal``` directory rather than assume that's the aforementioned "Hugo own template."

Here's my suggestion.
 2015-07-19 19:40:34 +02:00
digitalcraftsman
bfcf95b9de Add mention about .Hugo.Generator in 'Creating a theme' section 2015-07-19 19:39:32 +02:00
Bjørn Erik Pedersen
1a94148d06 Add paginator support for page groups 
Fixed #1274
 2015-07-18 14:53:52 +02:00
Bjørn Erik Pedersen
77c60a3440 Add RuneCount to Page 
Fixes #1266
 2015-07-12 11:05:37 +02:00
Éli Marshal
90af334c21 Omit protocol from embedded font resources 
Fixes the mixed content errors and loads fonts when accessing
https://gohugo.io/
 2015-07-11 01:10:45 +02:00
Arian Allenson M. Valdez
c4f81840f7 Change arianv sourceLink to master branch 2015-07-09 19:13:31 +02:00
Arian Allenson M. Valdez
88fe0e7c2c Add learnoverpass 2015-07-09 19:13:31 +02:00
Arian Allenson M. Valdez
5f69d3d654 Add arianv 2015-07-09 19:13:31 +02:00
Sam Debruyn
6807151a22 add a showcase of sa.muel.be 2015-07-09 10:56:40 +02:00
Borys Borysenko
c6d46ff2bd [Docs] Press page. Fix URL 2015-07-09 10:52:00 +02:00
kangkona
450dc7a411 Add a showcase of Kangkona 2015-07-08 07:42:04 +02:00
Rick Cogley
a945412475 Add how-to for foreign language month names 
FYI @nicolinuxfr, added the month name example.
 2015-07-08 07:38:52 +02:00
Rick Cogley
617fa2fe65 Add Rick and eSolia's sites to the Hugo docs showcase 2015-07-08 07:37:30 +02:00
Marc-Antoine Ruel
24c8226cbf Document Page.RawContent in templates/variables/ 2015-07-02 19:24:30 +02:00
Bjørn Erik Pedersen
a509a23255 Add doc for new Blackfriday options 
See #1220
See #1231
 2015-06-28 15:27:47 +02:00
Mario Sanchez Carrion
50df31406f added thumbnail 2015-06-26 21:26:17 +02:00
Mario Sanchez Carrion
d118d03714 Create mariosanchez.md 
Submitting site for consideration in Hugo Showcase
 2015-06-26 21:26:08 +02:00
tim
1b50ccd162 add vamp.io site as showcase 2015-06-26 20:59:40 +02:00
Jonathan Anderson
0987e98db3 Add support for baseof.ace templates in themes. 
When we find a template that requires a base template, we should also look
for that base template in the current theme.

Fixes #1215.
 2015-06-25 18:05:43 +02:00
Bjørn Erik Pedersen
67209dbfb3 docs: make the named value Data File example simpler 2015-06-22 20:25:17 +02:00
Sebastian Krause
e96624cce8 Update datafiles.md 
additional example for named data values
 2015-06-22 00:02:48 +02:00
Rick Cogley
847ad36e45 Add new tutorial for multilingual sites 
Simple tutorial showing one pattern for creating a multilingual site in
Hugo.
 2015-06-16 12:17:09 +02:00
Ariejan de Vroom
cc9536ec46 Update docs for last template function 2015-06-15 21:18:38 +02:00
Ariejan de Vroom
40a92a062d Add after to template function documentation 2015-06-15 21:18:38 +02:00
bep
beaa1b3aad Add some docs for IgnoreFiles 
See #1189
 2015-06-03 13:46:52 +02:00
vsopvsop
2690a8c1ea Update introduction.md 2015-05-31 13:49:41 +02:00
bep
beffe756a9 docs: getting usage up to spec 2015-05-27 11:59:19 +02:00
Anthony Fok
2a40475235 Add two articles about Hugo to the Press page 
* http://jbrodriguez.io/mobile-friendly-website-2/
* http://blog.hypriot.com/post/moved-from-posthaven-to-hugo/
 2015-05-26 21:46:40 -06:00
bep
beaa09a7f6 docs: add bepsays.com to showcase 2015-05-26 10:51:57 +02:00
Jeff Ramnani
102a3b95ae Document techniques for debugging templates. 
This information was previously scattered around in the forums and
mailing list.  Add it to the official docs to make things easier for new
users.

Fixes #1167
 2015-05-26 10:01:45 +02:00
spf13
fa58ef5394 Add GopherCon to the showcase 2015-05-25 11:55:48 -04:00
spf13
6f0b80c952 Add GoGB to the showcase 2015-05-25 11:55:33 -04:00
spf13
45efc5e4dc Add DavidePetilli to showcase 2015-05-25 11:55:19 -04:00
spf13
fe38dc2fa0 update release notes 2015-05-25 11:55:04 -04:00
spf13
20cb4c9314 Add new directions for maintaining press page 2015-05-25 11:54:47 -04:00
spf13
f49b63a4dd Move press page to top level menu 2015-05-25 11:54:22 -04:00
spf13
4a1773963b add dozens of articles to the press page 2015-05-25 11:53:37 -04:00
spf13
4c850b6921 Update release notes in prep for v0.14.0 2015-05-23 22:04:12 -04:00
bep
be778c3160 docs: some more on absURL, relURL 2015-05-22 23:43:02 +02:00
bep
be1366074c docs: add doc for substr 
Fixes #1156
 2015-05-22 22:36:25 +02:00
bep
be4376a022 docs: add doc for slicestr 
See #1156
 2015-05-22 22:20:45 +02:00
bep
be2e08c4ad docs: add doc for seq 
See #1156
 2015-05-22 22:17:41 +02:00
bep
be4a404f28 docs: add ToC to some more pages 2015-05-22 20:45:52 +02:00
bep
be71fda559 docs: avoid navbar hiding when jumping to in-page anchor 2015-05-22 20:18:22 +02:00
Jeff Ramnani
0d65ca27fd 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
7125103b1e Add ".Render" to the list of functions. 
Fixes: #1153
 2015-05-22 19:38:01 +02:00
Rick Cogley
321bac2fc2 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
be2842da18 Fix formatting in hugo command description 2015-05-21 20:05:29 +02:00
bep
be831d7409 Fix CLI command description for the top level 
And regenerate the commands doc.
 2015-05-21 13:30:11 +02:00
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
bep
ab5862cd00 Allow the same shortcode to be used with or without inline content 
Fixes #934
 2015-03-02 21:49:33 +01:00
Anthony Fok
bb13d82677 [Docs] NetBSD and ARM pre-built binaries are already provided 
See https://github.com/spf13/hugo/releases

What a pleasant surprise indeed!
How come I have never noticed them before?

And even `.deb` files are provided!  How amazing!
 2015-02-21 23:26:34 -07:00
spf13
e43eabacee Updating the final release notes for v0.13 2015-02-21 22:31:01 -05:00
Anthony Fok
88e7c031a8 [Docs] Clarify the switch to canonifyurls = false as default 
Quote from @spf13: "I also think it's the better default
and should continue to be the case going forward."

Also mention the use of `hugo config` to check the current value
of `canonifyurls`, thanks to suggestion by @bep.

Fixes #802
 2015-02-21 14:50:14 -07:00
Anthony Fok
ac189fd514 Update README.md and overview/installing.md 
- Clarify that Hugo may be built wherever Go is available;
- Add links to Git, Mercurial and Go;
- Unlist Bazaar: No libraries that Hugo depends on use it any more;
- Suggest the user to simply run `make` to build `hugo`
  to get `hugo version` to display the commit hash.
 2015-02-21 13:42:15 -07:00
riboflavin
aeddaee901 add note that running with watch doesn't produce a site suitable for deployment 2015-02-17 19:17:38 -08:00
karland
e31536dd85 Add information to highlighting with Payments 
Conflicts:
	docs/content/extras/highlighting.md
 2015-02-17 12:35:39 -05:00
Cyrill Schumacher
41c0e82f95 Moved futured getSQL topic to another branch 2015-02-17 12:14:39 -05:00
Cyrill Schumacher
b209f44335 getJson and getCsv documentation proof reading by @msjulias 2015-02-17 12:14:39 -05:00
Cyrill Schumacher
4342dd84fc Update Dynamic Content docs 2015-02-17 12:14:39 -05:00
Cyrill Schumacher
48a6d44786 Update doc 2015-02-17 12:14:39 -05:00
Cyrill Schumacher
47b7cfeb44 Add getSQL idea 2015-02-17 12:14:39 -05:00
Cyrill Schumacher
fdf8db9c21 Initial doc file: Dynamic Content 2015-02-17 12:14:39 -05:00
Anthony Fok
cb9fa62743 [Docs] Minor copyediting of highlighting.md 
Also add `apt-get` command for installing Pygments.
 2015-02-17 01:59:40 -07:00
karland
bd0de85dbc Add information to highlighting with Pygments 2015-02-17 01:49:44 -07:00
karland
1827680bea List of variables 
Some variables are currently not documented and others are explained
across the document. So, I tried to pull an overview from the source.
Pls double check. I am not 100% sure, what the purpose of some variables
is or whether they are only relevant for previous versions. Thanks
 2015-02-17 01:28:20 -07:00
Maxime Michel
09ed3c4b92 Fixed a typo 2015-02-17 01:16:41 -07:00
Anthony Fok
63e7b9705f [Docs] Add pointers to roadmap; new tweet and article 2015-02-16 09:02:56 -07:00
Ivan Fraixedes
366f991694 Another link in the same page 2015-02-14 18:35:37 -05:00
Ivan Fraixedes
b389a92383 Fixed invalid link to partials 2015-02-14 18:35:37 -05:00
Joseph Kaptur
462e666f45 Update docs so that figure includes the class parameter. 2015-02-14 18:35:00 -05:00
bep
87975e04eb Remove nohup.out committed by accident 2015-02-12 14:32:04 +01:00
bep
4820683330 Doc Data Files: Add section about themes and expanded the example a bit 2015-02-12 09:09:35 +01:00
Anthony Fok
664fd99135 Change "ctrl+c" to "Ctrl+C" 2015-02-11 01:11:50 -07:00
midinastasurazz
dbb86679a1 Fix typo: GetJson -> GetCsv 2015-02-11 00:57:17 -07:00
Greg Restall
7e28db18f2 Add showcase entry for consequently.org 
Consequently.org is a personal site for an academic, with a blog, list
of publications, classes and talks, all managed by hugo.
 2015-02-11 00:31:44 -07:00
spf13
e3daa359ec Update release notes for v0.13 2015-02-10 10:58:20 -05:00
bep
371c148c34 Fix alias for data files doc 2015-02-09 16:58:12 +01:00
bep
03fff880ec Add docs for Data Files 
Fixes #887
 2015-02-09 16:52:52 +01:00
Anthony Fok
4c7e119ca1 [Docs] Say which directory to clone the hugoThemes 
On http://gohugo.io/overview/quickstart/, explicitly state
that hugoThemes is to be cloned from within the working directory,
like it is stated on http://gohugo.io/themes/installing/.

Fixes #886
 2015-02-08 19:52:27 -07:00
bep
dd9344816a Scratch doc: Use the special $ variable to prevent confusion 2015-02-01 20:36:43 +01:00