From b0181e278b34eb3fee999776526b2d8b92423170 Mon Sep 17 00:00:00 2001 From: Anthony Fok Date: Fri, 9 Jan 2015 11:51:15 -0700 Subject: [PATCH] Some more random copyediting of Hugo docs - Change "livereload" and "live reload" to "LiveReload"; - Add a `$ ` prompt before example command lines (not exhaustive, work in progress); - Remove unnecessary whitespace from partials; - Revise the blackfriday options table in overview/configuration.md to make it narrower. - Manually set the language for highlight.js where appropriate - Rename "404" to "Custom 404 page", and remove incorrect reference to "homepage" - Credit the author of tutorials/github_pages_blog.md (Similar notes are necessary for other contributed pages where "I" am not spf13 to avoid reader confusion.) - Add CSS for `kbd` and `table` etc. to css/style.css; - etc. --- docs/content/extras/livereload.md | 30 ++++----- docs/content/extras/menus.md | 8 +-- docs/content/meta/release-notes.md | 2 +- docs/content/overview/configuration.md | 37 +++++++++-- docs/content/overview/installing.md | 18 +++--- docs/content/overview/introduction.md | 2 +- docs/content/overview/quickstart.md | 69 +++++++++++---------- docs/content/overview/usage.md | 8 +-- docs/content/templates/404.md | 7 ++- docs/content/tutorials/github_pages_blog.md | 26 ++++---- docs/layouts/partials/header.html | 2 +- docs/layouts/partials/menu.html | 4 +- docs/static/css/style.css | 44 +++++++++++++ 13 files changed, 163 insertions(+), 94 deletions(-) diff --git a/docs/content/extras/livereload.md b/docs/content/extras/livereload.md index a32614f58..ebbd3da2c 100644 --- a/docs/content/extras/livereload.md +++ b/docs/content/extras/livereload.md @@ -5,24 +5,24 @@ menu: parent: extras next: /extras/menus prev: /extras/crossreferences -title: Live Reload +title: LiveReload weight: 50 --- -Hugo may not be the first static site generator to utilize live reload +Hugo may not be the first static site generator to utilize LiveReload technology, but it’s the first to do it right. -The combination of Hugo’s insane build speed and live reload make +The combination of Hugo’s insane build speed and LiveReload make crafting your content pure joy. Virtually instantly after you hit save your rebuilt content will appear in your browser. -## Using livereload +## Using LiveReload -Hugo comes with livereload built in. There are no additional packages to -install. A common way to use hugo while developing a site is to have -hugo run a server and watch for changes. +Hugo comes with LiveReload built in. There are no additional packages to +install. A common way to use Hugo while developing a site is to have +Hugo run a server and watch for changes: - hugo server --watch + $ hugo server --watch This will run a full functioning web server while simultaneously watching your file system for additions, deletions or changes within @@ -40,22 +40,18 @@ fast they are barely noticeable, you merely need to glance at your open browser and you will see the change already there. This means that keeping the site open on a second monitor (or another -half of your current monitor), allows you to see exactly what your +half of your current monitor) allows you to see exactly what your content looks like without even leaving your text editor. -## Disabling livereload +## Disabling LiveReload -Live reload accomplishes this by injecting javascript into the pages it +LiveReload works by injecting JavaScript into the pages it creates that creates a web socket client to the hugo web socket server. Awesome for development, but not something you would want to do in production. Since many people use `hugo server --watch` in production to instantly display any updated content, we’ve made it easy to disable the -live reload functionality. - - hugo server --watch --disableLiveReload - - - +LiveReload functionality. + $ hugo server --watch --disableLiveReload diff --git a/docs/content/extras/menus.md b/docs/content/extras/menus.md index 5362903a7..957432567 100644 --- a/docs/content/extras/menus.md +++ b/docs/content/extras/menus.md @@ -41,7 +41,7 @@ And the following functions: * **HasChildren** bool -Additionally there are some relevant functions available on the page: +Additionally, there are some relevant functions available on the page: * **IsMenuCurrent** (menu string, menuEntry *MenuEntry ) bool * **HasMenuCurrent** (menu string, menuEntry *MenuEntry) bool @@ -89,7 +89,7 @@ available. You can also add entries to menus that aren’t attached to a piece of content. This takes place in the sitewide [config file](/overview/configuration). -Here’s an example (in TOML): +Here’s an example `config.toml`: [[menu.main]] name = "about hugo" @@ -101,7 +101,7 @@ Here’s an example (in TOML): pre = "" weight = -100 -Here’s an example (in YAML): +And the equivalent example `config.yaml`: --- menu: @@ -142,7 +142,7 @@ The following is an example: