Skip to content

Commit

Permalink
Squashed 'docs/' changes from 73f355ce..ef02e34e
Browse files Browse the repository at this point in the history
ef02e34e Correct the mmark example frontmatter parameter
6e91e900 SectionPagesMenu > sectionPagesMenu
1a0db1a6 Adjust sectionPagesMenu
f9f87d9d Fix extension's missing period.
7062ae07 Remove Press and Articles page
771f2b38 Remove outdated and redudant content file for release notes
64cf47c3 Remove outdated note in docs contribution guide
bdb11b89 Fix typo
8324af70 Fixes broken link on Roadmap
d93f0992 functions: Add all missing binary comparison operators
fb7ae80a Fix typo in usage.md
fbdae08b Fix typo in content-management/taxonomies.md
66fab8d2 Make <title> less stuttery
b3cd4c22 Remove old temp release notes
5589ba96 Fix typos in templates/lists.md
af3a0807 http > HTTP
b2af90ae Remove formatting in description of blog article
6e2e60a9 Add blog article about Netlify files
0bb6f2f2 Use title in archetype file
7b2490ff Get the Archetypes up to new spec
f401d69b Load CSS and JS via HTTP/2 server push
4aef4944 Adjust titles
362acdb2 Fix typo in quickstart
c2440560 Remove inline icons from installation guide
d2edcbc3 Revert "Fix links to Disqus template documentation"
622f49cf Add a full commands section at the quick start end
752f065b Fix server command in README
93e08e19 Fix links to Disqus template documentation
5e0cfaa9 Adjust Linux install
d51397c2 Fix broken link in Quick Start
1fb39846 Add /quickstart alias to quickstart
7440616b Add new and simpler quickstart
b3ec6986 Let page title correspond to function name replaceRE
b44499c9 Add YouTube tutorial about taxonomies
88b9eb0e Add RSS templates example
6c0bde3f Update slice.md
6c212ea6 Reorder to match the following content order
d2122992 Complete "content" spelling under theme components
e4824eb3 Fix the output shortcode and its usage
0adfc945 Add archetypes YouTube video
638e9d9b Fix double "your" typo in taxonomies.md

git-subtree-dir: docs
git-subtree-split: ef02e34eaf296c3f94b4446b3c3347771e786057
  • Loading branch information
bep committed Jul 31, 2017
1 parent 2c0d1cc commit 50ec65f
Show file tree
Hide file tree
Showing 50 changed files with 376 additions and 1,740 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,10 @@ git submodule update --init
Also note that the documentation version for a given version of Hugo can also be found in the `/docs` sub-folder of the [Hugo source repository](https://github.com/gohugoio/hugo).

Then to view the docs in your browser, run Hugo and open up the link:

```bash
hugo serve
▶ hugo server

Started building sites ...
.
.
Expand Down
10 changes: 4 additions & 6 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
---
linktitle: ""
title: "{{ replace .TranslationBaseName "-" " " | title }}"
date: {{ .Date }}
description: ""
godocref: ""
publishdate: ""
lastmod: ""
categories: []
tags: []
weight: 00
#tags: []
slug: ""
aliases: []
toc: false
draft: true
---
17 changes: 0 additions & 17 deletions archetypes/functions.md

This file was deleted.

13 changes: 0 additions & 13 deletions archetypes/showcase.md

This file was deleted.

16 changes: 0 additions & 16 deletions archetypes/tutorials.md

This file was deleted.

10 changes: 7 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ enableEmoji = true
footnotereturnlinkcontents = ""
languageCode = "en-us"
metaDataFormat = "yaml"
title = "Hugo: A Fast and Flexible Website Generator"
title = "Hugo"
theme = "gohugoioTheme"

googleAnalytics = "UA-7131036-4"
Expand All @@ -25,7 +25,7 @@ pygmentsCodeFences = true
pygmentsStyle = "friendly"

[outputs]
home = [ "HTML", "RSS", "REDIR" ]
home = [ "HTML", "RSS", "REDIR", "HEADERS" ]
section = [ "HTML", "RSS"]

[mediaTypes]
Expand All @@ -39,7 +39,11 @@ mediatype = "text/netlify"
baseName = "_redirects"
isPlainText = true
notAlternative = true

[outputFormats.HEADERS]
mediatype = "text/netlify"
baseName = "_headers"
isPlainText = true
notAlternative = true

[social]
twitter = "GoHugoIO"
Expand Down
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: "Hugo: A Fast and Flexible Website Generator"
title: "A Fast and Flexible Website Generator"
date: 2017-03-02T12:00:00-05:00
features:
- heading: Blistering Speed
Expand Down
2 changes: 1 addition & 1 deletion content/about/roadmap.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Feel free to [contribute to Hugo's development][devcontribute], [improve Hugo's
[migrate]: /tools/migrations/
[milestones]: https://github.com/gohugoio/hugo/milestone/14
[newissue]: https://github.com/gohugoio/hugo/issues/
[related forum thread]: https://disourse.gohugo.io/t/web-based-editor/155
[related forum thread]: https://discourse.gohugo.io/t/web-based-editor/155
[themes]: /themes/
[themescontrib]: /contribute/themes/
[tutorials]: /tutorials
Expand Down
20 changes: 8 additions & 12 deletions content/content-management/archetypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,8 @@ See above

**Archetypes** are content files in the [archetypes directory][] of your project that contain preconfigured [front matter][] for your website's [content types][]. Archetypes facilitate consistent metadata across your website content and allow content authors to quickly generate instances of a content type via the `hugo new` command.

{{< youtube S3Tj3UcTFz8 >}}

The `hugo new` generator for archetypes assumes your working directory is the content folder at the root of your project. Hugo is able to infer the appropriate archetype by assuming the content type from the content section passed to the CLI command:

```
Expand All @@ -47,15 +49,13 @@ To override the content type Hugo infers from `[content-section]`, add the `--ki

Running this command in a new site that does not have default or custom archetypes will create the following file:

{{% output file="content/posts/my-first-post.md" %}}
```
{{< output file="content/posts/my-first-post.md" >}}
+++
date = "2017-02-01T19:20:04-07:00"
title = "my first post"
draft = true
+++
```
{{% /output %}}
{{< /output >}}

{{% note %}}
In this example, if you do not already have a `content/posts` directory, Hugo will create both `content/posts/` and `content/posts/my-first-post.md` for you.
Expand Down Expand Up @@ -119,16 +119,14 @@ $ hugo new posts/my-new-post.md

Hugo then creates a new markdown file with the following front matter:

{{% output file="content/posts/my-new-post.md" %}}
```
{{< output file="content/posts/my-new-post.md" >}}
+++
categories = ["web development"]
date = "2017-02-01T19:20:04-07:00"
tags = ["golang", "hugo"]
title = "my new post"
+++
```
{{% /output %}}
{{< /output >}}

We see that the `title` and `date` key-values have been added in addition to the `tags` and `categories` key-values from `archetypes/default.md`.

Expand Down Expand Up @@ -160,17 +158,15 @@ $ hugo new posts/post-from-custom.md

This time, Hugo recognizes our custom `archetypes/posts.md` archetype and uses it instead of `archetypes/default.md`. The generated file will now include the full list of front matter parameters, as well as the base archetype's `title` and `date`:

{{% output file="content/posts/post-from-custom-archetype.md" %}}
```
{{< output file="content/posts/post-from-custom-archetype.md" >}}
+++
categories = ""
date = 2017-02-13T17:24:43-08:00
description = ""
tags = ""
title = "post from custom archetype"
+++
```
{{% /output %}}
{{< /output >}}

### Hugo Docs Custom Archetype

Expand Down
2 changes: 1 addition & 1 deletion content/content-management/formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ In the event that you want to only use Mmark in specific files, you can also def
---
title: My Post
date: 2017-04-01
markdown: mmark
markup: mmark
---
```

Expand Down
2 changes: 1 addition & 1 deletion content/content-management/multilingual.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ Translated articles are identified by the name of the content file.
1. `/content/about.en.md`
2. `/content/about.fr.md`

In this eample, the `about.md` will be assigned the configured `defaultContentLanguage`.
In this example, the `about.md` will be assigned the configured `defaultContentLanguage`.

1. `/content/about.md`
2. `/content/about.fr.md`
Expand Down
42 changes: 14 additions & 28 deletions content/content-management/shortcodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,16 +95,14 @@ The `figure` shortcode can use the following named parameters:

#### Example `figure` Output

{{% output file="figure-output-example.html" %}}
```
{{< output file="figure-output-example.html" >}}
<figure>
<img src="/media/spf13.jpg" />
<figcaption>
<h4>Steve Francia</h4>
</figcaption>
</figure>
```
{{% /output %}}
{{< /output >}}

### `gist`

Expand All @@ -130,11 +128,9 @@ If the gist contains several files and you want to quote just one of them, you c

#### Example `gist` Output

{{% output file="gist-output.html" %}}
```
{{< output file="gist-output.html" >}}
{{< gist spf13 7896402 >}}
```
{{% /output %}}
{{< /output >}}

#### Example `gist` Display

Expand Down Expand Up @@ -165,8 +161,7 @@ This shortcode will convert the source code provided into syntax-highlighted HTM

The `highlight` shortcode example above would produce the following HTML when the site is rendered:

{{% output file="tutorials/learn-html/index.html" %}}
```
{{< output file="tutorials/learn-html/index.html" >}}
<span style="color: #f92672">&lt;section</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;main&quot;</span><span style="color: #f92672">&gt;</span>
<span style="color: #f92672">&lt;div&gt;</span>
<span style="color: #f92672">&lt;h1</span> <span style="color: #a6e22e">id=</span><span style="color: #e6db74">&quot;title&quot;</span><span style="color: #f92672">&gt;</span>{{ .Title }}<span style="color: #f92672">&lt;/h1&gt;</span>
Expand All @@ -175,8 +170,7 @@ The `highlight` shortcode example above would produce the following HTML when th
{{ end }}
<span style="color: #f92672">&lt;/div&gt;</span>
<span style="color: #f92672">&lt;/section&gt;</span>
```
{{% /output %}}
{{< /output >}}

{{% note "More on Syntax Highlighting" %}}
To see even more options for adding syntax-highlighted code blocks to your website, see [Syntax Highlighting in Developer Tools](/tools/syntax-highlighting/).
Expand Down Expand Up @@ -206,11 +200,9 @@ You also have the option to hide the caption:

By adding the preceding `hidecaption` example, the following HTML will be added to your rendered website's markup:

{{% output file="instagram-hide-caption-output.html" %}}
```
{{< output file="instagram-hide-caption-output.html" >}}
{{< instagram BWNjjyYFxVx hidecaption >}}
```
{{% /output %}}
{{< /output >}}

#### Example `instagram` Display

Expand Down Expand Up @@ -265,11 +257,9 @@ Extract the value from the field `data-id` and pass it to the shortcode:

#### `speakerdeck` Example Output

{{% output file="speakerdeck-example-input.md" %}}
```
{{< output file="speakerdeck-example-input.md" >}}
{{< speakerdeck 4e8126e72d853c0060001f97 >}}
```
{{% /output %}}
{{< /output >}}

#### `speakerdeck` Example Display

Expand Down Expand Up @@ -297,11 +287,9 @@ Pass the tweet's ID from the URL as a parameter to the `tweet` shortcode:

Using the preceding `tweet` example, the following HTML will be added to your rendered website's markup:

{{% output file="example-tweet-output.html" %}}
```
{{< output file="example-tweet-output.html" >}}
{{< tweet 877500564405444608 >}}
```
{{% /output %}}
{{< /output >}}

#### Example `tweet` Display

Expand Down Expand Up @@ -329,11 +317,9 @@ Extract the ID from the video's URL and pass it to the `vimeo` shortcode:

Using the preceding `vimeo` example, the following HTML will be added to your rendered website's markup:

{{% output file="example-vimeo-output.html" %}}
```
{{< output file="example-vimeo-output.html" >}}
{{< vimeo 146022717 >}}
```
{{% /output %}}
{{< /output >}}

{{% tip %}}
If you want to further customize the visual styling of the YouTube or Vimeo output, add a `class` named parameter when calling the shortcode. The new `class` will be added to the `<div>` that wraps the `<iframe>` *and* will remove the inline styles. Note that you will need to call the `id` as a named parameter as well.
Expand Down
6 changes: 4 additions & 2 deletions content/content-management/taxonomies.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,8 @@ Term
Value
: a piece of content assigned to a term

{{< youtube "-np9GX6cL38" >}}

## Example Taxonomy: Movie Website

Let's assume you are making a website about movies. You may want to include the following taxonomies:
Expand Down Expand Up @@ -92,7 +94,7 @@ disableKinds = ["taxonomy","taxonomyTerm"]

### Default Destinations

When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your your configuration and used in your content front matter will create the following pages:
When taxonomies are used---and [taxonomy templates][] are provided---Hugo will automatically create both a page listing all the taxonomy's terms and individual pages with lists of content associated with each term. For example, a `categories` taxonomy declared in your configuration and used in your content front matter will create the following pages:

* A single page at `example.com/categories/` that lists all the [terms within the taxonomy][]
* [Individual taxonomy list pages][taxonomy templates] (e.g., `/categories/development/`) for each of the terms that shows a listing of all pages marked as part of that taxonomy within any content file's [front matter][]
Expand Down Expand Up @@ -163,7 +165,7 @@ project_url = "https://github.com/gohugoio/hugo"
title: "Hugo: A fast and flexible static site generator"
#tags: ["Development", "Go", "fast", "Blogging"]
categories: ["Development"]
categories: ["Go Web Dev"]
series: ["Go Web Dev"]
slug: "hugo"
project_url: "https://github.com/gohugoio/hugo"
---
Expand Down
Loading

0 comments on commit 50ec65f

Please sign in to comment.