Commit graph

194 commits

Author SHA1 Message Date
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