From 4161d542ce54b35e19c5652f07a1eb9bab39f1dd Mon Sep 17 00:00:00 2001 From: "Michael D. Johas Teener" <m@j0t.us> Date: Tue, 8 Apr 2014 17:15:56 +0200 Subject: [PATCH] Misc doc fixes * Pygments links and requirements for installation. * Fix to link to additional template functions in release notes for v0.10 --- docs/content/extras/highlighting.md | 4 ++-- docs/content/meta/release-notes.md | 2 +- docs/content/overview/installing.md | 7 ++++++- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/content/extras/highlighting.md b/docs/content/extras/highlighting.md index 6244a0cd..743e69ff 100644 --- a/docs/content/extras/highlighting.md +++ b/docs/content/extras/highlighting.md @@ -7,13 +7,13 @@ groups_weight: 15 Hugo provides the ability for you to highlight source code from within your content. Highlighting is performed by an external python based program called -pygments and is triggered via an embedded shortcode. If pygments is absent from +[pygments](http://pygments.org) and is triggered via an embedded shortcode. If pygments is absent from the path, it will silently simply pass the content along unhighlighted. ## Disclaimers - * **Warning** Pygments is relatively slow and our integration isn't + * **Warning** pygments is relatively slow and our integration isn't speed optimized. Expect much longer build times when using highlighting * Languages available depends on your pygments installation. * While pygments supports a few different output formats and options we currently diff --git a/docs/content/meta/release-notes.md b/docs/content/meta/release-notes.md index 84e2dadc..091a503d 100644 --- a/docs/content/meta/release-notes.md +++ b/docs/content/meta/release-notes.md @@ -14,7 +14,7 @@ groups_weight: 10 * Support for [paired shortcodes](/extras/shortcodes) * Shipping with some [shortcodes](/extras/shortcodes) (highlight & figure) * Adding [canonify](/extras/urls) option to keep urls relative - * A bunch of [additional template functions](/layouts/templatefunctions) + * A bunch of [additional template functions](/layout/functions) * Watching very large sites now works on mac * RSS generation improved. Limited to 50 items by default, can limit further in [template](/layout/rss) * Boolean params now supported in [frontmatter](/content/front-matter) diff --git a/docs/content/overview/installing.md b/docs/content/overview/installing.md index e80ace84..a72de884 100644 --- a/docs/content/overview/installing.md +++ b/docs/content/overview/installing.md @@ -23,7 +23,12 @@ where you don't have a privileged account. Ideally you should install it somewhere in your path for easy use. `/usr/local/bin` is the most probable location. -*the Hugo executible has no external dependencies.* +The Hugo executable has one *optional* external dependency for source code highlighting (pygments). + +### Installing pygments + +If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting) +you need to install the python-based pygments program. The procedure is outlined on the [pygments home page](http://pygments.org). ## Installing from source -- 2.30.2