Jacob Walker
4e16a6d4fd
docs: Fix markdown in content/extras/scratch.md
2016-09-15 11:35:39 -05:00
Frank Taillandier
cdf1edd549
docs: Fix French translation in multilingual.md
2016-09-15 15:25:31 +02:00
Mark D. Blackwell
0d1e96701f
docs: Improve Traversing Local Files
2016-09-15 15:15:04 +02:00
digitalcraftsman
e70cf1ace4
docs: Remove JPEG as format for showcase thumbnails
2016-09-11 18:18:28 +02:00
David Yates
d5379fd1fe
docs: Add davidyat.es to the showcase
2016-09-11 18:11:50 +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
Pascal Aubort
5ef45bec63
docs: Fix typos in multilingual section
2016-09-08 15:54:26 +02:00
Bjørn Erik Pedersen
2f7e8df5ba
docs: Fix spelling: HasTranslations > IsTranslated
2016-09-06 18:32:20 +03:00
Bjørn Erik Pedersen
93717aac5c
docs: Get the variable and funcs re multilingual up-to-date
2016-09-06 18:32:20 +03:00
Bjørn Erik Pedersen
d1212307f2
doc: Fix TOML vs YAML in multilang section
...
Updates ##2309
2016-09-06 18:32:19 +03:00
Bjørn Erik Pedersen
7610844004
Add IsTranslated to Node and Page
...
Makes the templates simpler.
See #2309
2016-09-06 18:32:19 +03:00
Bjørn Erik Pedersen
f1e1cdab3f
Improve i18n string handling
...
* Fall back to default language on missing translation file
* Add a i18n-warnings build flag
* If that flag is set, print a parseable and greppable string on missing translation strings
See #2303
2016-09-06 18:32:19 +03:00
Bjørn Erik Pedersen
8da040342e
Render main content language in root by default
...
Fixes #2312
2016-09-06 18:32:18 +03:00
Bjørn Erik Pedersen
54141f71dd
Improve language handling in URLs
...
The current "rendering language" is needed outside of Site. This commit moves the Language type to the helpers package, and then used to get correct correct language configuration in the markdownify template func.
This commit also adds two new template funcs: relLangURL and absLangURL.
See #2309
2016-09-06 18:32:18 +03:00
Bjørn Erik Pedersen
2079a23dd8
Make it possible to configure Blackfroday per language
...
See #2309
2016-09-06 18:32:17 +03:00
Bjørn Erik Pedersen
90de511017
Make taxonomies configurable per language
...
See #2312
2016-09-06 18:32:17 +03:00
Bjørn Erik Pedersen
f0b91852ea
Rework the multilingual docs
...
And in the same go adjusted some minor parts of the language API:
Add LanguagePrefix alias to Node and rename the Multilingual config section to Languages.
See #2309
2016-09-06 18:32:17 +03:00
Alexandre Bourget
ec33732fbe
Add multilingual support in Hugo
...
Implements:
* support to render:
* content/post/whatever.en.md to /en/2015/12/22/whatever/index.html
* content/post/whatever.fr.md to /fr/2015/12/22/whatever/index.html
* gets enabled when `Multilingual:` is specified in config.
* support having language switchers in templates, that know
where the translated page is (with .Page.Translations)
(when you're on /en/about/, you can have a "Francais" link pointing to
/fr/a-propos/)
* all translations are in the `.Page.Translations` map, including the current one.
* easily tweak themes to support Multilingual mode
* renders in a single swift, no need for two config files.
Adds a couple of variables useful for multilingual sites
Adds documentation (content/multilingual.md)
Added language prefixing for all URL generation/permalinking see in the
code base.
Implements i18n. Leverages the great github.com/nicksnyder/go-i18n lib.. thanks Nick.
* Adds "i18n" and "T" template functions..
2016-09-06 18:32:15 +03:00
Russ Shanahan
faa3472fa2
docs: Fix typo in Quickstart guide
...
To publish a post, draft status should be changed to `false`.
2016-09-06 14:34:46 +02:00
Vasiliy Solovey
ccc51fe764
docs: Add open.cinegy.com to the showcase
2016-09-06 14:32:33 +02:00
digitalcraftsman
723d4656b5
docs: Add Vim/Emacs plugin to tools section
2016-09-04 15:22:05 +02:00
integrii
a48ac6e945
docs: Clarify first level URL generation
2016-09-03 15:32:29 +02:00
Mark D. Blackwell
0614a59b0f
docs: Improve Quickstart guide
...
Fixes #2331 .
2016-09-03 15:19:01 +02:00
Mark D. Blackwell
696c67b04a
docs: Clarify Creating a New Theme
2016-09-01 20:34:00 -04:00
Nichlas Hummelsberger
bb1812b6af
docs: Mention theme config option on Usage page
2016-09-01 17:22:50 +02:00
sethmacleod
8e1bcea82f
docs: Update documentation for URLs
...
Using absolute URLs overrides relative URL behavior. This should be explicit in the docs.
2016-08-30 01:26:21 -04:00
vsopvsop
7cb8107735
docs: Correct spelling for "parameters" in partials.md
2016-08-29 12:25:53 +02:00
digitalcraftsman
38d034df38
docs: Document shuffle template func
...
Fixes #2393 .
2016-08-29 12:22:37 +02:00
Andreas Grunewald
6eff9e5015
docs: Update highlight.js example to latest version
...
Highlight.js has evolved quite a bit since it this doc was written. Updating the example to the latest 9.6 version of Highlight JS hosted by cloudflare
2016-08-25 14:05:34 +02:00
Eric
2fc05dad4e
docs: Add location of block template
2016-08-20 21:54:14 +02:00
Mark D. Blackwell
81f04ef4f0
docs: Clarify Usage
2016-08-19 14:38:20 -04:00
Anthony Fok
2530087ab1
docs: Add Spanish video tutorial by Verónica López to press.md
2016-08-19 08:26:26 -06:00
Steef Hegeman
c5d072990a
docs: Just a small grammar fix in quickstart.md
2016-08-18 20:58:29 +02:00
Mark D. Blackwell
3ce9de7672
docs: Follow through on watch default
2016-08-18 20:55:05 +02:00
Georg Hartmann
68c8e0e23d
docs: Correct name of release archives for OS X
...
Fixes #2341
2016-08-18 20:49:13 +02:00
Mark D. Blackwell
be429d2268
docs: Correct all erroneous swaps of "it's" and "its"
2016-08-18 20:42:40 +02:00
Mark D. Blackwell
8474b9defe
docs: Improve section 'Why did you write Hugo?'
2016-08-18 20:33:57 +02:00
Stephan Kulla
de1ca477b8
docs: Fix URLs in examples sites with path prefix
...
When baseurl ist something like "http://example.com/hugo/ " a link to
"/tags/..." does not work. Therefore I fixed the examples so that they
also work in cases where the website is not saved at the server's root.
See also https://discuss.gohugo.io/t/how-shall-i-link-a-taxonomy-page/3920
2016-08-18 20:15:37 +02:00
Mark Ayers
26725515c8
docs: Convert toml to yaml in config overview
2016-08-12 13:37:30 +02:00
Wade Fitzpatrick
b33bfd40be
docs: Add doc for time template func
2016-08-08 12:28:41 +02:00
Maxime Michel
f2faae0805
Remove maximeguitare.com from showcase
2016-08-06 23:37:11 +02:00
Randall Degges
0d9c0677f6
docs: Add rdegges.com to the showcase
2016-08-06 15:06:10 +02:00
astrochili
5824e80932
docs: Add romansilin.com to the showcase
2016-07-31 13:09:25 +02:00
digitalcraftsman
0087beefe1
docs: Add tumblr2hugomarkdown to tools section
2016-07-29 20:37:32 +02:00
digitalcraftsman
0d0a7596a2
docs: Add tumblr-importr to tools section
2016-07-29 20:36:10 +02:00
digitalcraftsman
04889a5ee6
docs: Document .File variables for pages
...
Fixes #2154 .
2016-07-29 20:12:28 +02:00
Chris DeLuca
333646c52d
docs: Drop .isDraft to new line
...
Bring **.isDraft** onto a new line, to be consistent with the other list items.
2016-07-29 20:10:40 +02:00
Jeremy Brown
e3e1f7a2bb
docs: Add a link to hugo-openapispec-shortcode
...
Added a link to the Hugo Open API Spec shortcode which allows you to embed OAI Spec (formerly known as Swagger) in your site.
2016-07-29 20:07:46 +02:00
Felipe Rohde
ddd5a92240
docs: Removed comma from json example.
...
The comma causing invalid json and hugo not compile the file based on the same example.
2016-07-29 20:01:23 +02:00
Max Milton
df0a4534cd
docs: Add missing configuration option disableHugoGeneratorInject
2016-07-29 19:58:25 +02:00
Weilin
9c458657da
docs: Add weilinshi.org to the showcase
2016-07-29 19:51:28 +02:00
zarina
17f53526ca
docs: Add CTL Compiled edtech blog to showcase
2016-07-29 19:46:53 +02:00
Leow Kah Man
76f332bfdc
docs: Add www.leowkahman.com to the showcase
2016-07-29 19:38:18 +02:00
Peter Panagiotakos
198efc89ca
docs: Add Algolia as commercial search service
2016-07-21 14:53:23 +02:00
Anthony Fok
c0eedfe956
docs: Update last-mod date of installing-on-windows.md
...
Sorry, this should have been part of the previous commit.
2016-07-18 18:06:39 -06:00
Anthony Fok
10ad648e2f
docs: Fix PATH issue in the instruction for Windows 10
...
i.e., "The PATH entry should be the folder where Hugo lives, not the binary."
Fixes #2280 .
Also fix a rendering issue with list entries that consist of multiple
paragraphs by using four spaces instead of two. Special thanks to
@shurcooL for the insight! (Fixes #2285 )
Also made a few minor formatting tweaks.
2016-07-18 17:58:26 -06:00
Cathal Garvey
20555b1630
Add htmlEscape
and htmlUnescape
template functions
...
These functions allow trivial escaping and unescaping of HTML entities,
and make it far easier to compose other functions for the creation of
parameterised URLs.
2016-07-19 00:14:05 +02:00
Michael Orr
0a812beb12
tpl: Modify tpl.humanize to ordinalize integer input
...
Add logic to tpl.humanize such that it understands input of int literals
or strings which represent an integer. When tpl.humanize sees this type
of input, it will use inflect.Ordinalize as opposed to the standard
inflect.Humanize.
Fixes #1886
2016-07-13 22:09:59 +02:00
Bjørn Erik Pedersen
4a48b5f326
Replace replace-this-with-your-hugo-site.com with example.org
...
Fixes #2264
2016-07-08 21:38:28 +02:00
JoeArizona
0ce6438268
docs: Update install instructions to reflect hugo.exe filename change
...
The install tutorial instructed users to rename the *.exe file to
hugo.exe because it used to have a big long name.
In Hugo 0.16 the file is already named hugo.exe, so the tutorial
made no sense on that point. Edited out those instructions.
2016-06-30 02:16:16 -06:00
Riku-Pekka Silvola
e140070c9a
docs: Add tutorial for GitLab Pages
2016-06-30 00:35:59 -06:00
Anthony Fok
195a2b3845
docs: Suggests the use of delimiter for taxonomy listing
...
as a shortcut suggested by @digitalcraftsman.
See #2143
2016-06-29 22:52:29 -06:00
Roy Reveltas
364686ecbb
docs: Add additional example for taxonomies listing
...
Add another example how to list taxonomies inline,
adding title (singular or plural) and commas between taxonomies.
See #2143
2016-06-29 22:36:34 -06:00
marco
c21e2b3b4d
tpl: Enable safeHTMLAttr
...
See #2234 and #347
2016-06-27 09:18:14 -06:00
Bjørn Erik Pedersen
29ca323a34
docs: Regen commands doc
...
Fixes #2235
2016-06-22 14:03:18 +02:00
Cameron Moore
a4b8496210
docs: Fix typo is 0.16 release notes
2016-06-20 13:21:10 -05:00
Martijn ten Bhömer
357c9db235
docs: Add mtbhomer.com to the showcase
2016-06-19 16:12:59 +02:00
Cesare
6ba074562c
docs: Add upbeat.it to the showcase
2016-06-14 18:19:03 +02:00
Roberto Rosario
c01f98255b
docs: Add mayan-edms to the showcase
2016-06-14 18:13:19 +02:00
Hanchen Wang
f7b2e532e2
docs: Add ExpiryDate to the list of variables
2016-06-14 15:45:26 +02:00
Hanchen Wang
448f0306d7
docs: Example of how to use Order by ExpiryDate
2016-06-14 15:45:26 +02:00
Hanchen Wang
02d2f05e74
docs: Add instructions on buildExpired in build configurations
2016-06-14 15:45:26 +02:00
Hanchen Wang
6e9fbf8ad6
docs: Add expirydate to front-matter doc
2016-06-14 15:45:26 +02:00
Marvin Pinto
5d3aabcb32
Update the alias generated HTML files to conform to the W3C HTML spec
...
- W3C recommends that there be a [whitespace character][1] between the
`;` and the `url=` portions.
- W3C also recommends that there be a [title][2] child in the `head`
element
[1]: https://www.w3.org/TR/html-markup/meta.http-equiv.refresh.html
[2]: https://www.w3.org/TR/html-markup/head.html
Closes #1933
2016-06-09 15:57:35 +02:00
James Campbell
48ebd598a9
docs: Add jamescampbell.us to the showcase
2016-06-06 21:04:02 +02:00
Steve Francia
7212e51347
Update release-notes.md
...
bump 0.16 to the correct date and add meta generator note.
2016-06-06 08:37:59 -04:00
Bjørn Erik Pedersen
80ebe0578a
Update release-notes.md
2016-06-04 21:44:38 +02:00
Bjørn Erik Pedersen
60184823e5
docs. Add the guranteed exit -1 on eror to Hugo 0.16 rel notes
...
It is a minor thing, but BIG thing for many, including myself.
2016-06-04 00:14:32 +02:00
Bjørn Erik Pedersen
cf10d4ce79
Some polish and addends to 0.16 release notes
2016-06-03 22:54:18 +02:00
Bjørn Erik Pedersen
d4e5fa6fdf
Pull the shootouts about 0.16 into the intro section
2016-06-03 20:53:33 +02:00
Steve Francia
834d41771b
update release notes for 0.16 release
2016-06-03 11:33:51 -04:00
Frank Blecha
ce05dfa553
docs: Grammar fix in overview/quickstart.md
2016-06-02 22:13:01 +02:00
digitalcraftsman
4ab5ed6c21
docs: Add Digital Ocean articles to press section
2016-05-30 20:25:50 +02:00
digitalcraftsman
d486396ff5
docs: Add c't magazine article to press section
2016-05-29 12:02:07 +02:00
digitalcraftsman
20358f46c8
docs: Document UniqueID page variable
2016-05-27 20:14:52 +02:00
Roy Reveltas
5611631539
docs: Add an example of how to use .PrevInSection
...
It's not a common knowledge what the "pointer" is so let's
add an example of how to use .PrevInSection
2016-05-27 20:02:29 +02:00
David King
c21b1558ae
docs: Add note about live reload script injection
...
Answers common question in docs.
https://discuss.gohugo.io/t/livereload-only-works-on-the-homepage/1006/4
2016-05-27 19:51:17 +02:00
Brijesh Bittu
dcee05b2ae
docs: Fix minor typo in overview/quickstart.md
2016-05-27 19:32:27 +02:00
Peter Y. Chuang
efae41c186
docs: Add novelist.xyz to the showcase
2016-05-22 14:08:45 +02:00
Martin Linkov
90362933ee
docs: Fix typo / readability in extras/menu.md
2016-05-22 11:30:29 +02:00
Stefano Chiodino
6dec7b3ea6
docs: Add stefano.chodino.uk to the showcase gallery.
2016-05-22 11:25:07 +02:00
Andreas Linz
dec744316e
docs: Add klingt.net to the showcase gallery
2016-05-18 12:23:40 +02:00
Amit Saha
9305deca15
docs: Clarify that watch is enabled by default
2016-05-18 12:08:26 +02:00
nurp
9aa70af1a3
docs: Fix git clone for hugo_theme_robust in quickstart guide
2016-05-17 21:10:04 +02:00
digitalcraftsman
ac938d9da7
docs: Improve description for .Hugo.Generator
2016-05-11 20:59:31 +02:00
Cameron Moore
fd40fe39bc
docs: Document relativeURLs
...
Fixes #1342
2016-05-07 16:52:18 -05:00
yuzroz
7cbafa4ec5
docs: Fix typo in overview/configuration.md
2016-05-04 21:44:28 +02:00
Alex Leventer
a07889d4a3
docs: Fix typo in templates/content.md
2016-05-04 21:40:22 +02:00
mattjmcnaughton
bf4206a02f
docs: Fix links in the documentation
...
A couple of internal links use `#toc_4` to attempt to locate a document
element within another document page. In both of these instances, there
is no element on the linked to pages with the id `#toc_4`. This commit
updates those links with the document elements which were the original
intended links, meaning these links now take you directly to the
intended element.
Signed-off-by: mattjmcnaughton <mattjmcnaughton@gmail.com>
2016-05-04 21:35:24 +02:00
Masashi Tsuru
5caea6f2da
docs: Add 2626.info to the showcase
2016-05-03 20:23:04 +02:00
Christopher Mancini
09038865c2
tpl: Add intersect operator to where function
...
Returns true if a given field value that is a slice / array of strings, integers or floats contains elements in common with the matching value. It follows the same rules as the intersect function.
Closes #1945
2016-04-28 00:58:47 +02:00
Göran Svensson
ffbd2b6c67
docs: Add appernetic blog to showcase
2016-04-27 22:05:45 +02:00
Fahri Aydos
c5723a8931
docs: Add aydos.com to the showcase
2016-04-23 21:57:31 +02:00
Bjørn Erik Pedersen
4152ce886b
Update release-notes.md
2016-04-22 23:45:39 +02:00
Bjørn Erik Pedersen
7da9163df9
docs: More on release notes
2016-04-22 21:37:36 +02:00
Bjørn Erik Pedersen
efa9bdcc11
docs: Order by Lastmod in release notes
2016-04-22 20:47:21 +02:00
Bjørn Erik Pedersen
eb627ca16d
docs: Order by Lastmod
2016-04-22 20:46:04 +02:00
Alvaro Garcia
fbca53ac32
docs: Add notion of exiting the themes folder in quickstart
2016-04-22 19:47:59 +02:00
Cian Ruane
fe2b22fe6f
docs: Grammar fixes in overview/quickstart.md
2016-04-22 19:43:11 +02:00
lynxiayel
19afa5ee6c
docs: Update showcase screenshot of yulinling.net
2016-04-22 19:36:33 +02:00
Bjørn Erik Pedersen
81a2466b80
docs: Add some more fixes to release notes
2016-04-22 19:03:46 +02:00
digitalcraftsman
ebefa47691
docs: Move image-width fix to style.css
2016-04-22 18:23:12 +02:00
Cameron Moore
76738347d3
docs: Fix findRE typo
2016-04-21 12:38:40 -05:00
Bjørn Erik Pedersen
a8e05b1196
docs: Fix some typos in release notes
2016-04-21 11:27:12 +02:00
Bjørn Erik Pedersen
56cd308184
doc: Get feature list of 0.16 release notes up to date
2016-04-21 11:23:54 +02:00
Bjørn Erik Pedersen
01c3389857
📚 Add ENV support to release notes
2016-04-20 23:50:43 +02:00
Bjørn Erik Pedersen
5e9b147c2a
docs: Add some doc about ENV config
...
See #2090
2016-04-18 18:45:37 +02:00
digitalcraftsman
0743c76795
docs: Fix typo in tutorials/how-to-contribute-to-hugo.md
2016-04-17 20:57:21 +02:00
Ernie Hershey
215b8939bd
docs: Fix grammar in templates/partials.md
...
Noticed this sentence seemingly missing a word or two.
2016-04-15 18:57:30 +02:00
callmelanmao
fed5f20f89
docs: Add tutorialonfly.com to the showcase
2016-04-15 18:54:42 +02:00
digitalcraftsman
4b4bfa6a9c
docs: Fix lastmod date for chipsncookies in showcase
2016-04-15 18:45:46 +02:00
David Coallier
6fdb0ca6eb
docs: Add barricade.io to the showcase
2016-04-15 18:43:55 +02:00
Sam Debruyn
ba0a661410
docs: sa.muel.be has moved to chipsncookies.com in showcase
2016-04-15 18:31:07 +02:00
Robert Basic
24cb0d1f58
tpl: Do not write to cache when ignoring cache
...
Fixes #2067
Closes #2069
2016-04-14 10:48:26 +02:00
Bjørn Erik Pedersen
88759eecf7
docs: Add plainIDAnchors change to release notes
2016-04-12 18:39:07 +02:00
Bjørn Erik Pedersen
0d9a5f8023
docs: Update default for plainIDAnchors
2016-04-12 18:36:45 +02:00
Bjørn Erik Pedersen
2468b10eb3
docs: Fix example for Param method
...
Fixes #2070
2016-04-11 13:26:33 +02:00
Robert Basic
37fb2d43e5
helpers: Ignore cache for Pygments when flag set
...
When the --ignoreCache flag is set to true, do not write and read
the Pygments results to/from the cache directory.
Fixes #2066
Closes #2068
2016-04-10 20:55:57 +02:00
Bjørn Erik Pedersen
ff7eec2f48
docs: Regenerate the commands docs
2016-04-09 23:01:55 +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
Göran Svensson
39c74b70dc
docs: Add commercial services to the "Tools" section
2016-04-09 14:03:45 +02:00
JoeArizona
88a07b7564
docs: Fix missing step in Windows version check instructions
...
The procedure Start button --> Settings --> About was missing a step. Corrected it to: Start --> Settings --> System --> About. Also replaced ASCII arrows (-->) with Unicode right arrow character (U+2192).
2016-04-09 13:43:40 +02:00
Erik Ebsen
65f9427031
docs: Document Go 1.6's new ability to trim whitespace
2016-04-09 13:21:23 +02:00
Bjørn Erik Pedersen
e4d328d835
docs: Fix Go version in install guide
2016-04-09 13:16:56 +02:00
digitalcraftsman
ac1ec5c72c
docs: Remove remaining Mercurial references
2016-04-09 12:40:58 +02:00
digitalcraftsman
e6e98bf52d
docs: Remove Mercurial from contribution tutorial
...
Fixes #2064
2016-04-08 21:52:50 +02:00
digitalcraftsman
ebf3cef162
docs: Add "How to contribute to Hugo" tutorial
2016-04-08 19:18:58 +02:00
Julien Chien
16ad628114
docs: Fix references to section list templates
...
Fixes #2032
2016-04-08 10:15:48 -05:00
Anthony Fok
6d2898b33b
docs: Correct date for proper sorting in showcase
2016-04-08 20:23:10 +08:00
Sven Dowideit
1648e327c0
Document and clean SourceRelativeLinksEval code
2016-04-07 20:10:38 +02:00
digitalcraftsman
5bfe16ef8d
tpl: Add findRE template func
2016-04-05 22:26:03 +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
ysqi
0698f294c6
docs: Add yushuangqi.com to the showcase
2016-04-04 20:37:39 +02:00
digitalcraftsman
dea06f863e
docs: embed YouTube video in Windows installation tutorial
2016-04-03 14:28:12 +02:00
JohnBlood
2304614639
docs: Update set PATH instructions for Windows
2016-04-03 14:22:50 +02:00
JohnBlood
1adf40355b
docs: Add alternative for Wordpress import
...
I have had trouble getting the Wordpress to Hugo exporter working, so I
added this tip for others to take advantage of.
2016-04-03 13:35:42 +02:00
digitalcraftsman
4502c4e3ae
docs: Add documentation for hasPrefix template func
...
Fixes #2039
2016-04-03 00:44:43 +02:00
Bjørn Erik Pedersen
c2277fcbc1
docs: Add doc and a test for readDir
...
Fixes #2009
2016-03-31 23:16:42 +02:00
Bjørn Erik Pedersen
4f66f790b1
Add readFile template func
...
This also includes a refactor of the hugofs package and its usage.
The motivation for that is:
The Afero filesystems are brilliant. Hugo's way of adding a dozen of global variables for the different filesystems was a mistake. In readFile (and also in some other places in Hugo today) we need a way to restrict the access inside the working dir. We could use ioutil.ReadFile and implement the path checking, checking the base path and the dots ("..") etc. But it is obviously better to use an Afero BasePathFs combined witha ReadOnlyFs. We could create a use-once-filesystem and handle the initialization ourselves, but since this is also useful to others and the initialization depends on some other global state (which would mean to create a new file system on every invocation), we might as well do it properly and encapsulate the predefined set of filesystems. This change also leads the way, if needed, to encapsulate the file systems in a struct, making it possible to have several file system sets in action at once (parallel multilanguage site building? With Moore's law and all...)
Fixes #1551
2016-03-31 21:24:18 +02:00