mirror of
https://github.com/gohugoio/hugo.git
synced 2024-05-11 05:54:58 +00:00
[Docs] Copyediting
* Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
This commit is contained in:
Anthony Fok
@@ -132,9 +132,12 @@ but only these three.</small></td>
|
||||
**Note** that these flags must be grouped under the `blackfriday` key and can be set on **both site and page level**. If set on page, it will override the site setting. Example:
|
||||
|
||||
<table class="table">
|
||||
<thead>
|
||||
<tr>
|
||||
<th>TOML</th><th>YAML</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td><pre><code>[blackfriday]
|
||||
angledQuotes = true
|
||||
@@ -150,10 +153,11 @@ but only these three.</small></td>
|
||||
- hardLineBreak
|
||||
</code></pre></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
## Notes
|
||||
|
||||
Config changes are not reflected with [LiveReload](/extras/livereload).
|
||||
Config changes are not reflected with [LiveReload](/extras/livereload/).
|
||||
|
||||
Please restart `hugo server --watch` whenever you make a config change.
|
||||
|
||||
@@ -31,15 +31,15 @@ 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.
|
||||
|
||||
On OS X, if you have [Homebrew](http://brew.sh), installation is even
|
||||
On OS X, if you have [Homebrew](http://brew.sh/), installation is even
|
||||
easier: just run `brew install hugo`.
|
||||
|
||||
### Installing Pygments (optional)
|
||||
|
||||
The Hugo executable has one *optional* external dependency for source code highlighting (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).
|
||||
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/).
|
||||
|
||||
## Upgrading Hugo
|
||||
|
||||
@@ -64,8 +64,12 @@ placed in your `PATH`.
|
||||
`go get` will then fetch Hugo and all its dependent libraries to your
|
||||
`$GOPATH/src` directory, and compile everything into the final `hugo`
|
||||
(or `hugo.exe`) executable, which you will find sitting in the
|
||||
`$GOPATH/bin/hugo` directory, all ready to go!
|
||||
`$GOPATH/bin/` directory, all ready to go!
|
||||
|
||||
You may run `go get` with the `-u` option to update Hugo's dependencies:
|
||||
|
||||
$ go get -u -v github.com/spf13/hugo
|
||||
|
||||
## Contributing
|
||||
|
||||
Please see the [contributing guide](/doc/contributing).
|
||||
Please see the [contributing guide](/doc/contributing/).
|
||||
|
||||
@@ -52,43 +52,43 @@ Hugo boasts the following features:
|
||||
|
||||
* Extremely fast build times (~1 ms per page)
|
||||
* Completely cross platform: Runs on <i class="fa fa-apple"></i> Mac OS X, <i class="fa fa-linux"></i> Linux, <i class="fa fa-windows"></i> Windows, and more!
|
||||
* Easy [installation](/overview/installing)
|
||||
* Render changes [on the fly](/overview/usage) with [LiveReload](/extras/livereload) as you develop
|
||||
* Easy [installation](/overview/installing/)
|
||||
* Render changes [on the fly](/overview/usage/) with [LiveReload](/extras/livereload/) as you develop
|
||||
* Complete theme support
|
||||
* Host your site anywhere
|
||||
|
||||
### Organization
|
||||
|
||||
* Straightforward [organization](/content/organization)
|
||||
* Support for [website sections](/content/sections)
|
||||
* Completely customizable [URLs](/extras/urls)
|
||||
* Support for configurable [taxonomies](/indexes/overview) which includes categories and tags. Create your own custom organization of content
|
||||
* Ability to [sort content](/content/ordering) as you desire
|
||||
* Automatic [table of contents](/extras/toc) generation
|
||||
* Straightforward [organization](/content/organization/)
|
||||
* Support for [website sections](/content/sections/)
|
||||
* Completely customizable [URLs](/extras/urls/)
|
||||
* Support for configurable [taxonomies](/taxonomies/overview/) which includes categories and tags. Create your own custom organization of content
|
||||
* Ability to [sort content](/content/ordering/) as you desire
|
||||
* Automatic [table of contents](/extras/toc/) generation
|
||||
* Dynamic menu creation
|
||||
* [Pretty URLs](/extras/urls) support
|
||||
* [Permalink](/extras/permalinks) pattern support
|
||||
* [Aliases](/extras/aliases) (redirects)
|
||||
* [Pretty URLs](/extras/urls/) support
|
||||
* [Permalink](/extras/permalinks/) pattern support
|
||||
* [Aliases](/extras/aliases/) (redirects)
|
||||
|
||||
### Content
|
||||
|
||||
* Content written in [Markdown](/content/example)
|
||||
* Support for TOML, YAML and JSON metadata in [frontmatter](/content/front-matter)
|
||||
* Completely [customizable homepage](/layout/homepage)
|
||||
* Support for multiple [content types](/content/types)
|
||||
* Automatic and user defined [summaries](/content/summaries)
|
||||
* [Shortcodes](/extras/shortcodes) to enable rich content inside of Markdown
|
||||
* ["Minutes to Read"](/layout/variables) functionality
|
||||
* ["Wordcount"](/layout/variables) functionality
|
||||
* Content written in [Markdown](/content/example/)
|
||||
* Support for TOML, YAML and JSON metadata in [frontmatter](/content/front-matter/)
|
||||
* Completely [customizable homepage](/layout/homepage/)
|
||||
* Support for multiple [content types](/content/types/)
|
||||
* Automatic and user defined [summaries](/content/summaries/)
|
||||
* [Shortcodes](/extras/shortcodes/) to enable rich content inside of Markdown
|
||||
* ["Minutes to Read"](/layout/variables/) functionality
|
||||
* ["Wordcount"](/layout/variables/) functionality
|
||||
|
||||
### Additional Features
|
||||
|
||||
* Integrated [Disqus](https://disqus.com/) comment support
|
||||
* Automatic [RSS](/layout/rss) creation
|
||||
* Automatic [RSS](/layout/rss/) creation
|
||||
* Support for [Go](http://golang.org/pkg/html/template/), [Amber](https://github.com/eknkc/amber) and [Ace](http://ace.yoss.si/) HTML templates
|
||||
* Syntax [highlighting](/extras/highlighting) powered by [Pygments](http://pygments.org/)
|
||||
* Syntax [highlighting](/extras/highlighting/) powered by [Pygments](http://pygments.org/)
|
||||
|
||||
See what's coming next in the [roadmap](/meta/roadmap).
|
||||
See what's coming next in the [roadmap](/meta/roadmap/).
|
||||
|
||||
## Who should use Hugo?
|
||||
|
||||
@@ -135,9 +135,9 @@ as I have writing it.
|
||||
|
||||
## Next Steps
|
||||
|
||||
* [Install Hugo](/overview/installing)
|
||||
* [Quick start](/overview/quickstart)
|
||||
* [Join the Mailing List](/community/mailing-list)
|
||||
* [Star us on GitHub](http://github.com/spf13/hugo)
|
||||
* [Discussion Forum](http://discuss.gohugo.io)
|
||||
* [Install Hugo](/overview/installing/)
|
||||
* [Quick start](/overview/quickstart/)
|
||||
* [Join the Mailing List](/community/mailing-list/)
|
||||
* [Star us on GitHub](https://github.com/spf13/hugo)
|
||||
* [Discussion Forum](http://discuss.gohugo.io/)
|
||||
|
||||
|
||||
@@ -135,7 +135,7 @@ Stop the Hugo process by hitting <kbd>Ctrl</kbd>+<kbd>C</kbd>. Then run the foll
|
||||
Web Server is available at http://localhost:1313
|
||||
Press ctrl+c to stop
|
||||
|
||||
Open your [favorite editor](http://vim.spf13.com), edit and save your content, and watch as Hugo rebuilds and reloads automatically.
|
||||
Open your [favorite editor](http://vim.spf13.com/), edit and save your content, and watch as Hugo rebuilds and reloads automatically.
|
||||
|
||||
It’s especially productive to leave a browser open on a second monitor
|
||||
and just glance at it whenever you save. You don’t even need to tab to
|
||||
|
||||
@@ -27,12 +27,12 @@ The top level of a source directory will typically have the following elements:
|
||||
|
||||
Learn more about the different directories and what their purpose is:
|
||||
|
||||
* [config](/overview/configuration)
|
||||
* [archetypes](/content/archetypes)
|
||||
* [content](/content/organization)
|
||||
* [layouts](/layout/overview)
|
||||
* [config](/overview/configuration/)
|
||||
* [archetypes](/content/archetypes/)
|
||||
* [content](/content/organization/)
|
||||
* [layouts](/layout/overview/)
|
||||
* [static](/themes/creation#toc_4)
|
||||
* [themes](/themes/overview)
|
||||
* [themes](/themes/overview/)
|
||||
|
||||
|
||||
## Example
|
||||
|
||||
@@ -74,7 +74,7 @@ is saved.
|
||||
Press ctrl+c to stop
|
||||
|
||||
Hugo can even run a server and create your site at the same time! Hugo
|
||||
implements [LiveReload](/extras/livereload) technology to automatically reload any open pages in
|
||||
implements [LiveReload](/extras/livereload/) technology to automatically reload any open pages in
|
||||
all browsers (including mobile).
|
||||
|
||||
$ hugo server -ws ~/mysite
|
||||
|
||||
Reference in New Issue
Block a user