Commit graph

81 commits

Author SHA1 Message Date
Bjørn Erik Pedersen
a7765bb3c1 Merge commit 'dd78d5b23fe597f4461aa4199401b4e07c0612e2' as 'docs' 2017-06-26 20:46:06 +02:00
Bjørn Erik Pedersen
8be3934b59 docs: Remove
Docs site is moved to https://github.com/gohugoio/hugoDocs

Will be re-added here as a Git submodule.
2017-06-14 10:32:16 +02:00
Dan Callahan
c2ffdfab63 docs: Fix documentation of non-existent 'editor' config 2017-03-17 23:57:53 +01:00
Bjørn Erik Pedersen
eb572c8a18 docs: Add documentation for disableKinds
Fixes #3054
2017-02-26 21:51:53 +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
Bjørn Erik Pedersen
a988d3cf36 docs: Remove the source relative links docs
See #3028
2017-02-13 16:35:05 +07:00
Cameron Moore
d332aa1606 docs: Update GitInfo usage docs 2016-12-15 11:15:15 +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
digitalcraftsman
001e2bbe8a docs: Set correct default archetype directory in overview
Fixes #2719.
2016-11-23 19:53:24 +01:00
Albert Nigmatzianov
f21e2f25c9 all: Unify case of config variable names
All config variables starts with low-case and uses camelCase.

If there is abbreviation at the beginning of the name, the whole
abbreviation will be written in low-case.
If there is abbreviation at the end of the name, the
whole abbreviation will be written in upper-case.
For example, rssURI.
2016-10-24 20:56:00 +02:00
Mitchell Cohen
e7e2a1ca02 tpl: Improve tests and docs for i18n 2016-09-20 11:11:57 +02:00
Mark D. Blackwell
83533a8881 docs: Improve Overview Configuration manual 2016-09-17 21:29:37 -04:00
digitalcraftsman
e80453a991 tpl: Add EnableMissingTranslationPlaceholders option
Fixes #2451
2016-09-16 17:20:29 +02:00
digitalcraftsman
9dab62c559 docs: List config options for multilingual feature 2016-09-16 14:36:54 +02:00
Bjørn Erik Pedersen
eaf2f9bce5 Add TODO list support for Blackfriday
* Add CSS class to TODO list and list items
* Add a flag to turn task list support off

Fixes #2269
2016-09-09 13:08:20 +02:00
Mark Ayers
26725515c8 docs: Convert toml to yaml in config overview 2016-08-12 13:37:30 +02:00
Max Milton
df0a4534cd docs: Add missing configuration option disableHugoGeneratorInject 2016-07-29 19:58:25 +02:00
Hanchen Wang
02d2f05e74 docs: Add instructions on buildExpired in build configurations 2016-06-14 15:45:26 +02:00
yuzroz
7cbafa4ec5 docs: Fix typo in overview/configuration.md 2016-05-04 21:44:28 +02:00
Bjørn Erik Pedersen
5e9b147c2a docs: Add some doc about ENV config
See #2090
2016-04-18 18:45:37 +02:00
Bjørn Erik Pedersen
0d9a5f8023 docs: Update default for plainIDAnchors 2016-04-12 18:36:45 +02:00
digitalcraftsman
b7efbdc12f hugolib: Add option to disable rendering of 404 page
Fixes #1889
Closes #2037
2016-04-09 20:25:59 +02:00
Sven Dowideit
1648e327c0 Document and clean SourceRelativeLinksEval code 2016-04-07 20:10:38 +02:00
Bjørn Erik Pedersen
54750b0780 Do not create robots.txt by default
Meny people, including me, have a custom robots.txt in static.

Also remove that option from the command line; it doesn't feel
important enough.

Fixes ##2049
2016-04-05 22:20:39 +02:00
Philipp Oppermann
43b5dfabb5 Disable syntax guessing for PygmentsCodeFences by default
This disables highlighting for fenced code blocks without explicitly specified language. It also introduces a new `PygmentsCodeFencesGuessSyntax` config option (defaulting to false).

To enable syntax guessing again, add the following to your config file: `PygmentsCodeFencesGuessSyntax = true`

This is a breaking change.
2016-04-04 22:19:36 +02:00
Bjørn Erik Pedersen
cafb784799 Add emoji support
This uses the Emoji map from https://github.com/kyokomi/emoji -- but with a custom replacement implementation.

The built-in are fine for most use cases, but in Hugo we do care about pure speed.

The benchmarks below are skewed in Hugo's direction as the source and result is a byte slice,
Kyokomi's implementation works best with strings.

Curious: The easy-to-use `strings.Replacer` is also plenty fast.

```
BenchmarkEmojiKyokomiFprint-4  	   20000	     86038 ns/op	   33960 B/op	     117 allocs/op
BenchmarkEmojiKyokomiSprint-4  	   20000	     83252 ns/op	   38232 B/op	     122 allocs/op
BenchmarkEmojiStringsReplacer-4	  100000	     21092 ns/op	   17248 B/op	      25 allocs/op
BenchmarkHugoEmoji-4           	  500000	      5728 ns/op	     624 B/op	      13 allocs/op
```

Fixes #1891
2016-03-11 15:51:37 -06:00
Darrel Herbst
06e90b1237 Add documentation for Google Analytics internal template
Fixes #1654
2016-02-13 11:41:21 +01:00
Ray Lai
49c2761b28 docs: Fix typo: Janapese → Japanese 2016-02-07 12:53:13 +08:00
Cameron Moore
9b8d2ce52b Remove destination from config file docs 2016-01-30 07:47:41 -06:00
Bjørn Erik Pedersen
01f71babfc docs: Add lastmod to content files
Based on last commit in Git.
2016-01-06 23:55:18 +01:00
Ivan Fraixedes
9a6dc6c791 Add embeded template for robots.txt 2016-01-05 23:36:16 +01:00
Kartik Singhal
0bb3b49c00 Update doc to reflect default value of watch variable 2016-01-04 12:35:26 -05:00
digitalcraftsman
47587321d9 Add themesDir option to configuration
themesDir can be used to change the default
path of the themes folder.

Fixes 1556
2016-01-01 14:46:40 -05:00
Cameron Moore
280b2f294e Document PreserveTaxonomyNames
Fixes #1648
2015-12-11 10:17:26 -07:00
Anthony Fok
b557f6249f Change plainIdAnchors to plainIDAnchors in docs
Also add a note saying that these blackfriday flags are
very case-sensitive as of Hugo v0.15.

Thanks to @ryanclarke for noticing the change in behaviour.

See also spf13/hugo@5838420
2015-11-30 00:19:04 -07:00
digitalcraftsman
2519b70793 Docs: remove note about config changes and manual livereload 2015-11-27 15:40:17 -07:00
Anthony Fok
e95db67b20 Add smartDashes flag for Blackfriday
To allow the end users to disable any form of smart dashes
(LaTeX-style or not) while keeping the rest of Blackfriday
SmartyPants features.

Depends on https://github.com/russross/blackfriday/pull/190
"Add HTML_SMARTYPANTS_DASHES for toggling smart dashes"
to be accepted by Blackfriday developers.
2015-10-30 13:30:25 -06:00
coderzh
ccd83c3040 Docs: Added hasCJKLanguage global config flag and isCJKLanguage FrontMatter
See #1399
2015-10-09 16:26:48 +02:00
Anthony Fok
db85299c00 Complete the Url-to-URL transition in docs
See #959
2015-09-13 05:22:12 -06:00
chrongzhang
52d94fa675 Add config option "disablePathToLower"
Enabling this prevents lowercasing of the path/url.

Fixes #557
2015-09-01 15:26:02 +02:00
Michael Diamond
209166a261 Added sitemap configuration documentation. 2015-08-08 15:04:52 -06: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
Bjørn Erik Pedersen
a509a23255 Add doc for new Blackfriday options
See #1220
See #1231
2015-06-28 15:27:47 +02:00
bep
beaa1b3aad Add some docs for IgnoreFiles
See #1189
2015-06-03 13:46:52 +02:00
bep
be920fdb2c Add a line in doc about the RelativeURL setting
Fixes #1145
2015-05-17 15:44:33 +02:00
Andre R
84f4c21d4a Fix datePublished to publishdate 2015-05-16 15:58:37 +02:00