feat: add exampleSite
nodejh
4 years ago
parent
5a1a09962e
commit
c92e4ed28c
@ -0,0 +1,55 @@
|
|||||||
|
baseURL: https://gohugo.io
|
||||||
|
languageCode: en-us
|
||||||
|
title: Hugo Themes
|
||||||
|
theme: mini
|
||||||
|
googleAnalytics: your-google-analytics-id
|
||||||
|
hasCJKLanguage: true
|
||||||
|
permalinks:
|
||||||
|
posts: /posts/:title/
|
||||||
|
|
||||||
|
disqusShortname: your-disqus-shorname
|
||||||
|
|
||||||
|
# Hugo Configure Markup
|
||||||
|
# see: https://gohugo.io/getting-started/configuration-markup#highlight
|
||||||
|
markup:
|
||||||
|
highlight:
|
||||||
|
guessSyntax: true
|
||||||
|
style: emacs
|
||||||
|
|
||||||
|
|
||||||
|
# Social links in footer, support github,twitter,stackoverflow,facebook
|
||||||
|
social:
|
||||||
|
# e.g.
|
||||||
|
github: 'your-github-link'
|
||||||
|
twitter: 'your-github-link'
|
||||||
|
stackoverflow: 'your-github-link'
|
||||||
|
# facebook: 'your-facebook-link'
|
||||||
|
|
||||||
|
|
||||||
|
# Site parameters
|
||||||
|
params:
|
||||||
|
# Site Author
|
||||||
|
author: Author
|
||||||
|
# Author biography
|
||||||
|
bio: Software Engineer
|
||||||
|
# Site Description, used in HTML meat
|
||||||
|
description: My Blog
|
||||||
|
enableRSS: true
|
||||||
|
|
||||||
|
# Optional
|
||||||
|
home: '' # Default: Home
|
||||||
|
about: '' # Default: About
|
||||||
|
archive: '' # Default: Archive
|
||||||
|
subscribe: '' # Default: Subscribe
|
||||||
|
olderPosts: '' # Default: Older Posts
|
||||||
|
newerPosts: '' # Default: Newer Posts
|
||||||
|
copyright: ''
|
||||||
|
title404: '' # Default: 404 - Page Not Found
|
||||||
|
subtitle404: '' # Default: The content you're looking for doesn't seem to exist.
|
||||||
|
readMore: '' # Default: Read More
|
||||||
|
|
||||||
|
# Extra links in navigation
|
||||||
|
links:
|
||||||
|
# e.g.
|
||||||
|
# - name: Project
|
||||||
|
# path: /project
|
||||||
@ -0,0 +1,27 @@
|
|||||||
|
# Compiled Object files, Static and Dynamic libs (Shared Objects)
|
||||||
|
*.o
|
||||||
|
*.a
|
||||||
|
*.so
|
||||||
|
|
||||||
|
# Folders
|
||||||
|
_obj
|
||||||
|
_test
|
||||||
|
|
||||||
|
# Architecture specific extensions/prefixes
|
||||||
|
*.[568vq]
|
||||||
|
[568vq].out
|
||||||
|
|
||||||
|
*.cgo1.go
|
||||||
|
*.cgo2.c
|
||||||
|
_cgo_defun.c
|
||||||
|
_cgo_gotypes.go
|
||||||
|
_cgo_export.*
|
||||||
|
|
||||||
|
_testmain.go
|
||||||
|
|
||||||
|
*.exe
|
||||||
|
*.test
|
||||||
|
|
||||||
|
/public
|
||||||
|
/themes
|
||||||
|
.DS_Store
|
||||||
@ -0,0 +1,21 @@
|
|||||||
|
The MIT License (MIT)
|
||||||
|
|
||||||
|
Copyright (c) 2014 Steve Francia
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
in the Software without restriction, including without limitation the rights
|
||||||
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||||
|
copies of the Software, and to permit persons to whom the Software is
|
||||||
|
furnished to do so, subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all
|
||||||
|
copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||||
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||||
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||||
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||||
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||||
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||||
|
SOFTWARE.
|
||||||
@ -0,0 +1,29 @@
|
|||||||
|
# hugoBasicExample
|
||||||
|
|
||||||
|
This repository offers an example site for [Hugo](https://gohugo.io/) and also it provides the default content for demos hosted on the [Hugo Themes Showcase](https://themes.gohugo.io/).
|
||||||
|
|
||||||
|
# Using
|
||||||
|
|
||||||
|
1. [Install Hugo](https://gohugo.io/overview/installing/)
|
||||||
|
2. Clone this repository
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/gohugoio/hugoBasicExample.git
|
||||||
|
cd hugoBasicExample
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Clone the repository you want to test. If you want to test all Hugo Themes then follow the instructions provided [here](https://github.com/gohugoio/hugoThemes#installing-all-themes)
|
||||||
|
|
||||||
|
4. Run Hugo and select the theme of your choosing
|
||||||
|
|
||||||
|
```bash
|
||||||
|
hugo server -t YOURTHEME
|
||||||
|
```
|
||||||
|
|
||||||
|
5. Under `/content/` this repository contains the following:
|
||||||
|
|
||||||
|
- A section called `/post/` with sample markdown content
|
||||||
|
- A headless bundle called `homepage` that you may want to use for single page applications. You can find instructions about headless bundles over [here](https://gohugo.io/content-management/page-bundles/#headless-bundle)
|
||||||
|
- An `about.md` that is intended to provide the `/about/` page for a theme demo
|
||||||
|
|
||||||
|
6. If you intend to build a theme that does not fit in the content structure provided in this repository, then you are still more than welcome to submit it for review at the [Hugo Themes](https://github.com/gohugoio/hugoThemes/issues) respository
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
+++
|
||||||
|
author = "Hugo Authors"
|
||||||
|
+++
|
||||||
@ -0,0 +1,25 @@
|
|||||||
|
+++
|
||||||
|
title = "About"
|
||||||
|
description = "Hugo, the world's fastest framework for building websites"
|
||||||
|
date = "2019-02-28"
|
||||||
|
aliases = ["about-us", "about-hugo", "contact"]
|
||||||
|
author = "Hugo Authors"
|
||||||
|
+++
|
||||||
|
|
||||||
|
Written in Go, Hugo is an open source static site generator available under the [Apache Licence 2.0.](https://github.com/gohugoio/hugo/blob/master/LICENSE) Hugo supports TOML, YAML and JSON data file types, Markdown and HTML content files and uses shortcodes to add rich content. Other notable features are taxonomies, multilingual mode, image processing, custom output formats, HTML/CSS/JS minification and support for Sass SCSS workflows.
|
||||||
|
|
||||||
|
Hugo makes use of a variety of open source projects including:
|
||||||
|
|
||||||
|
* https://github.com/yuin/goldmark
|
||||||
|
* https://github.com/alecthomas/chroma
|
||||||
|
* https://github.com/muesli/smartcrop
|
||||||
|
* https://github.com/spf13/cobra
|
||||||
|
* https://github.com/spf13/viper
|
||||||
|
|
||||||
|
Hugo is ideal for blogs, corporate websites, creative portfolios, online magazines, single page applications or even a website with thousands of pages.
|
||||||
|
|
||||||
|
Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.
|
||||||
|
|
||||||
|
Websites built with Hugo are extremely fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
|
||||||
|
|
||||||
|
Learn more and contribute on [GitHub](https://github.com/gohugoio).
|
||||||
@ -1,15 +0,0 @@
|
|||||||
+++
|
|
||||||
date = "2015-06-20T14:02:37+02:00"
|
|
||||||
title = "About"
|
|
||||||
hidden = true
|
|
||||||
+++
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ipsa ullam earum dolorum! Sed, perspiciatis.
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit.
|
|
||||||
|
|
||||||
***
|
|
||||||
|
|
||||||
### Lorem ipsum dolor.
|
|
||||||
|
|
||||||
Lorem ipsum dolor sit amet, consectetur adipisicing elit. Ea dicta corporis ad inventore itaque impedit dolor atque amet exercitationem! Veniam qui voluptas maiores vel laudantium necessitatibus, velit ducimus! Iste hic facere, accusamus fugiat enim facilis.
|
|
||||||
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
date: 2019-05-28
|
||||||
|
type: section
|
||||||
|
layout: "archives"
|
||||||
|
---
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: 'Our Difference'
|
||||||
|
button: 'About us'
|
||||||
|
weight: 2
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Ipsum dolor sit amet, et essent mediocritatem quo.
|
||||||
@ -0,0 +1,3 @@
|
|||||||
|
---
|
||||||
|
headless: true
|
||||||
|
---
|
||||||
@ -0,0 +1,7 @@
|
|||||||
|
---
|
||||||
|
title: 'We Help Business Grow'
|
||||||
|
button: 'Our Work'
|
||||||
|
weight: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Lorem ipsum dolor sit amet, et essent mediocritatem quo, choro volumus oporteat an mei. Numquam dolores mel eu, mea docendi omittantur et, mea ea duis erat. Elit melius cu ius. Per ex novum tantas putant, ei his nullam aliquam apeirian. Aeterno quaestio constituto sea an, no eum intellegat assueverit.
|
||||||
@ -0,0 +1,6 @@
|
|||||||
|
+++
|
||||||
|
aliases = ["posts", "articles", "blog", "showcase", "docs"]
|
||||||
|
title = "Posts"
|
||||||
|
author = "Hugo Authors"
|
||||||
|
tags = ["index"]
|
||||||
|
+++
|
||||||
@ -0,0 +1,46 @@
|
|||||||
|
+++
|
||||||
|
author = "Hugo Authors"
|
||||||
|
title = "Emoji Support"
|
||||||
|
date = "2019-03-05"
|
||||||
|
description = "Guide to emoji usage in Hugo"
|
||||||
|
tags = [
|
||||||
|
"emoji",
|
||||||
|
]
|
||||||
|
+++
|
||||||
|
|
||||||
|
Emoji can be enabled in a Hugo project in a number of ways.
|
||||||
|
<!--more-->
|
||||||
|
The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes).
|
||||||
|
|
||||||
|
To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g.
|
||||||
|
|
||||||
|
<p><span class="nowrap"><span class="emojify">🙈</span> <code>:see_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙉</span> <code>:hear_no_evil:</code></span> <span class="nowrap"><span class="emojify">🙊</span> <code>:speak_no_evil:</code></span></p>
|
||||||
|
<br>
|
||||||
|
|
||||||
|
The [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) is a useful reference for emoji shorthand codes.
|
||||||
|
|
||||||
|
***
|
||||||
|
|
||||||
|
**N.B.** The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack; e.g.
|
||||||
|
|
||||||
|
{{< highlight html >}}
|
||||||
|
.emoji {
|
||||||
|
font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols;
|
||||||
|
}
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
{{< css.inline >}}
|
||||||
|
<style>
|
||||||
|
.emojify {
|
||||||
|
font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols;
|
||||||
|
font-size: 2rem;
|
||||||
|
vertical-align: middle;
|
||||||
|
}
|
||||||
|
@media screen and (max-width:650px) {
|
||||||
|
.nowrap {
|
||||||
|
display: block;
|
||||||
|
margin: 25px 0;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
</style>
|
||||||
|
{{< /css.inline >}}
|
||||||
@ -0,0 +1,148 @@
|
|||||||
|
+++
|
||||||
|
author = "Hugo Authors"
|
||||||
|
title = "Markdown Syntax Guide"
|
||||||
|
date = "2019-03-11"
|
||||||
|
description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
||||||
|
tags = [
|
||||||
|
"markdown",
|
||||||
|
"css",
|
||||||
|
"html",
|
||||||
|
]
|
||||||
|
categories = [
|
||||||
|
"themes",
|
||||||
|
"syntax",
|
||||||
|
]
|
||||||
|
series = ["Themes Guide"]
|
||||||
|
aliases = ["migrate-from-jekyl"]
|
||||||
|
+++
|
||||||
|
|
||||||
|
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
|
||||||
|
<!--more-->
|
||||||
|
|
||||||
|
## Headings
|
||||||
|
|
||||||
|
The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
|
||||||
|
|
||||||
|
# H1
|
||||||
|
## H2
|
||||||
|
### H3
|
||||||
|
#### H4
|
||||||
|
##### H5
|
||||||
|
###### H6
|
||||||
|
|
||||||
|
## Paragraph
|
||||||
|
|
||||||
|
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
|
||||||
|
|
||||||
|
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
|
||||||
|
|
||||||
|
## Blockquotes
|
||||||
|
|
||||||
|
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a `footer` or `cite` element, and optionally with in-line changes such as annotations and abbreviations.
|
||||||
|
|
||||||
|
#### Blockquote without attribution
|
||||||
|
|
||||||
|
> Tiam, ad mint andaepu dandae nostion secatur sequo quae.
|
||||||
|
> **Note** that you can use *Markdown syntax* within a blockquote.
|
||||||
|
|
||||||
|
#### Blockquote with attribution
|
||||||
|
|
||||||
|
> Don't communicate by sharing memory, share memory by communicating.<br>
|
||||||
|
> — <cite>Rob Pike[^1]</cite>
|
||||||
|
|
||||||
|
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
|
||||||
|
|
||||||
|
## Tables
|
||||||
|
|
||||||
|
Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
|
||||||
|
|
||||||
|
Name | Age
|
||||||
|
--------|------
|
||||||
|
Bob | 27
|
||||||
|
Alice | 23
|
||||||
|
|
||||||
|
#### Inline Markdown within tables
|
||||||
|
|
||||||
|
| Italics | Bold | Code |
|
||||||
|
| -------- | -------- | ------ |
|
||||||
|
| *italics* | **bold** | `code` |
|
||||||
|
|
||||||
|
## Code Blocks
|
||||||
|
|
||||||
|
#### Code block with backticks
|
||||||
|
|
||||||
|
```html
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Example HTML5 Document</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p>Test</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Code block indented with four spaces
|
||||||
|
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Example HTML5 Document</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p>Test</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
|
||||||
|
#### Code block with Hugo's internal highlight shortcode
|
||||||
|
{{< highlight html >}}
|
||||||
|
<!doctype html>
|
||||||
|
<html lang="en">
|
||||||
|
<head>
|
||||||
|
<meta charset="utf-8">
|
||||||
|
<title>Example HTML5 Document</title>
|
||||||
|
</head>
|
||||||
|
<body>
|
||||||
|
<p>Test</p>
|
||||||
|
</body>
|
||||||
|
</html>
|
||||||
|
{{< /highlight >}}
|
||||||
|
|
||||||
|
## List Types
|
||||||
|
|
||||||
|
#### Ordered List
|
||||||
|
|
||||||
|
1. First item
|
||||||
|
2. Second item
|
||||||
|
3. Third item
|
||||||
|
|
||||||
|
#### Unordered List
|
||||||
|
|
||||||
|
* List item
|
||||||
|
* Another item
|
||||||
|
* And another item
|
||||||
|
|
||||||
|
#### Nested list
|
||||||
|
|
||||||
|
* Fruit
|
||||||
|
* Apple
|
||||||
|
* Orange
|
||||||
|
* Banana
|
||||||
|
* Dairy
|
||||||
|
* Milk
|
||||||
|
* Cheese
|
||||||
|
|
||||||
|
## Other Elements — abbr, sub, sup, kbd, mark
|
||||||
|
|
||||||
|
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
|
||||||
|
|
||||||
|
H<sub>2</sub>O
|
||||||
|
|
||||||
|
X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
|
||||||
|
|
||||||
|
Press <kbd><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
|
||||||
|
|
||||||
|
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.
|
||||||
@ -0,0 +1,49 @@
|
|||||||
|
---
|
||||||
|
author: Hugo Authors
|
||||||
|
title: Math Typesetting
|
||||||
|
date: 2019-03-08
|
||||||
|
description: A brief guide to setup KaTeX
|
||||||
|
math: true
|
||||||
|
---
|
||||||
|
|
||||||
|
Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries.
|
||||||
|
<!--more-->
|
||||||
|
|
||||||
|
In this example we will be using [KaTeX](https://katex.org/)
|
||||||
|
|
||||||
|
- Create a partial under `/layouts/partials/math.html`
|
||||||
|
- Within this partial reference the [Auto-render Extension](https://katex.org/docs/autorender.html) or host these scripts locally.
|
||||||
|
- Include the partial in your templates like so:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
{{ if or .Params.math .Site.Params.math }}
|
||||||
|
{{ partial "math.html" . }}
|
||||||
|
{{ end }}
|
||||||
|
```
|
||||||
|
|
||||||
|
- To enable KaTex globally set the parameter `math` to `true` in a project's configuration
|
||||||
|
- To enable KaTex on a per page basis include the parameter `math: true` in content files
|
||||||
|
|
||||||
|
**Note:** Use the online reference of [Supported TeX Functions](https://katex.org/docs/supported.html)
|
||||||
|
|
||||||
|
{{< math.inline >}}
|
||||||
|
{{ if or .Page.Params.math .Site.Params.math }}
|
||||||
|
<!-- KaTeX -->
|
||||||
|
<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.css" integrity="sha384-zB1R0rpPzHqg7Kpt0Aljp8JPLqbXI3bhnPWROx27a9N0Ll6ZP/+DiW/UqRcLbRjq" crossorigin="anonymous">
|
||||||
|
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/katex.min.js" integrity="sha384-y23I5Q6l+B6vatafAwxRu/0oK/79VlbSz7Q9aiSZUvyWYIYsd+qj+o24G5ZU2zJz" crossorigin="anonymous"></script>
|
||||||
|
<script defer src="https://cdn.jsdelivr.net/npm/katex@0.11.1/dist/contrib/auto-render.min.js" integrity="sha384-kWPLUVMOks5AQFrykwIup5lo0m3iMkkHrD0uJ4H5cjeGihAutqP0yW0J6dpFiVkI" crossorigin="anonymous" onload="renderMathInElement(document.body);"></script>
|
||||||
|
{{ end }}
|
||||||
|
{{</ math.inline >}}
|
||||||
|
|
||||||
|
### Examples
|
||||||
|
|
||||||
|
{{< math.inline >}}
|
||||||
|
<p>
|
||||||
|
Inline math: \(\varphi = \dfrac{1+\sqrt5}{2}= 1.6180339887…\)
|
||||||
|
</p>
|
||||||
|
{{</ math.inline >}}
|
||||||
|
|
||||||
|
Block math:
|
||||||
|
$$
|
||||||
|
\varphi = 1+\frac{1} {1+\frac{1} {1+\frac{1} {1+\cdots} } }
|
||||||
|
$$
|
||||||
@ -0,0 +1,45 @@
|
|||||||
|
+++
|
||||||
|
author = "Hugo Authors"
|
||||||
|
title = "Placeholder Text"
|
||||||
|
date = "2019-03-09"
|
||||||
|
description = "Lorem Ipsum Dolor Si Amet"
|
||||||
|
tags = [
|
||||||
|
"markdown",
|
||||||
|
"text",
|
||||||
|
]
|
||||||
|
+++
|
||||||
|
|
||||||
|
Lorem est tota propiore conpellat pectoribus de pectora summo. <!--more-->Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
|
||||||
|
|
||||||
|
1. Exierant elisi ambit vivere dedere
|
||||||
|
2. Duce pollice
|
||||||
|
3. Eris modo
|
||||||
|
4. Spargitque ferrea quos palude
|
||||||
|
|
||||||
|
Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
|
||||||
|
|
||||||
|
1. Comas hunc haec pietate fetum procerum dixit
|
||||||
|
2. Post torum vates letum Tiresia
|
||||||
|
3. Flumen querellas
|
||||||
|
4. Arcanaque montibus omnes
|
||||||
|
5. Quidem et
|
||||||
|
|
||||||
|
# Vagus elidunt
|
||||||
|
|
||||||
|
<svg class="canon" xmlns="http://www.w3.org/2000/svg" overflow="visible" viewBox="0 0 496 373" height="373" width="496"><g fill="none"><path stroke="#000" stroke-width=".75" d="M.599 372.348L495.263 1.206M.312.633l494.95 370.853M.312 372.633L247.643.92M248.502.92l246.76 370.566M330.828 123.869V1.134M330.396 1.134L165.104 124.515"></path><path stroke="#ED1C24" stroke-width=".75" d="M275.73 41.616h166.224v249.05H275.73zM54.478 41.616h166.225v249.052H54.478z"></path><path stroke="#000" stroke-width=".75" d="M.479.375h495v372h-495zM247.979.875v372"></path><ellipse cx="498.729" cy="177.625" rx=".75" ry="1.25"></ellipse><ellipse cx="247.229" cy="377.375" rx=".75" ry="1.25"></ellipse></g></svg>
|
||||||
|
|
||||||
|
[The Van de Graaf Canon](https://en.wikipedia.org/wiki/Canons_of_page_construction#Van_de_Graaf_canon)
|
||||||
|
|
||||||
|
## Mane refeci capiebant unda mulcebat
|
||||||
|
|
||||||
|
Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. **Faces illo pepulere** tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.
|
||||||
|
|
||||||
|
Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.
|
||||||
|
|
||||||
|
Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel **mitis temploque** vocatus, inque alis, *oculos nomen* non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides **parte**.
|
||||||
|
|
||||||
|
{{< css.inline >}}
|
||||||
|
<style>
|
||||||
|
.canon { background: white; width: 100%; height: auto; }
|
||||||
|
</style>
|
||||||
|
{{< /css.inline >}}
|
||||||
@ -0,0 +1,34 @@
|
|||||||
|
+++
|
||||||
|
author = "Hugo Authors"
|
||||||
|
title = "Rich Content"
|
||||||
|
date = "2019-03-10"
|
||||||
|
description = "A brief description of Hugo Shortcodes"
|
||||||
|
tags = [
|
||||||
|
"shortcodes",
|
||||||
|
"privacy",
|
||||||
|
]
|
||||||
|
+++
|
||||||
|
|
||||||
|
Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.
|
||||||
|
<!--more-->
|
||||||
|
---
|
||||||
|
|
||||||
|
## YouTube Privacy Enhanced Shortcode
|
||||||
|
|
||||||
|
{{< youtube ZJthWmvUzzc >}}
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Twitter Simple Shortcode
|
||||||
|
|
||||||
|
{{< twitter_simple 1085870671291310081 >}}
|
||||||
|
|
||||||
|
<br>
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Vimeo Simple Shortcode
|
||||||
|
|
||||||
|
{{< vimeo_simple 48912912 >}}
|
||||||
File diff suppressed because it is too large
Load Diff
@ -1,350 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "(Hu)go Template Primer"
|
|
||||||
description = "Hugo uses the excellent go library for its template engine. "
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"templates",
|
|
||||||
"themes",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
menu = "main"
|
|
||||||
+++
|
|
||||||
|
|
||||||
Hugo uses the excellent [go][] [html/template][gohtmltemplate] library for
|
|
||||||
its template engine. It is an extremely lightweight engine that provides a very
|
|
||||||
small amount of logic.
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
|
|
||||||
In our experience that it is just the right amount of
|
|
||||||
logic to be able to create a good static website. If you have used other
|
|
||||||
template systems from different languages or frameworks you will find a lot of
|
|
||||||
similarities in go templates.
|
|
||||||
|
|
||||||
|
|
||||||
This document is a brief primer on using go templates. The [go docs][gohtmltemplate]
|
|
||||||
provide more details.
|
|
||||||
|
|
||||||
## Introduction to Go Templates
|
|
||||||
|
|
||||||
Go templates provide an extremely simple template language. It adheres to the
|
|
||||||
belief that only the most basic of logic belongs in the template or view layer.
|
|
||||||
One consequence of this simplicity is that go templates parse very quickly.
|
|
||||||
|
|
||||||
A unique characteristic of go templates is they are content aware. Variables and
|
|
||||||
content will be sanitized depending on the context of where they are used. More
|
|
||||||
details can be found in the [go docs][gohtmltemplate].
|
|
||||||
|
|
||||||
## Basic Syntax
|
|
||||||
|
|
||||||
Go lang templates are html files with the addition of variables and
|
|
||||||
functions.
|
|
||||||
|
|
||||||
**Go variables and functions are accessible within {{ }}**
|
|
||||||
|
|
||||||
Accessing a predefined variable "foo":
|
|
||||||
|
|
||||||
{{ foo }}
|
|
||||||
|
|
||||||
**Parameters are separated using spaces**
|
|
||||||
|
|
||||||
Calling the add function with input of 1, 2:
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
**Methods and fields are accessed via dot notation**
|
|
||||||
|
|
||||||
Accessing the Page Parameter "bar"
|
|
||||||
|
|
||||||
{{ .Params.bar }}
|
|
||||||
|
|
||||||
**Parentheses can be used to group items together**
|
|
||||||
|
|
||||||
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Variables
|
|
||||||
|
|
||||||
Each go template has a struct (object) made available to it. In hugo each
|
|
||||||
template is passed either a page or a node struct depending on which type of
|
|
||||||
page you are rendering. More details are available on the
|
|
||||||
[variables](/layout/variables) page.
|
|
||||||
|
|
||||||
A variable is accessed by referencing the variable name.
|
|
||||||
|
|
||||||
<title>{{ .Title }}</title>
|
|
||||||
|
|
||||||
Variables can also be defined and referenced.
|
|
||||||
|
|
||||||
{{ $address := "123 Main St."}}
|
|
||||||
{{ $address }}
|
|
||||||
|
|
||||||
|
|
||||||
## Functions
|
|
||||||
|
|
||||||
Go template ship with a few functions which provide basic functionality. The go
|
|
||||||
template system also provides a mechanism for applications to extend the
|
|
||||||
available functions with their own. [Hugo template
|
|
||||||
functions](/layout/functions) provide some additional functionality we believe
|
|
||||||
are useful for building websites. Functions are called by using their name
|
|
||||||
followed by the required parameters separated by spaces. Template
|
|
||||||
functions cannot be added without recompiling hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ add 1 2 }}
|
|
||||||
|
|
||||||
## Includes
|
|
||||||
|
|
||||||
When including another template you will pass to it the data it will be
|
|
||||||
able to access. To pass along the current context please remember to
|
|
||||||
include a trailing dot. The templates location will always be starting at
|
|
||||||
the /layout/ directory within Hugo.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ template "chrome/header.html" . }}
|
|
||||||
|
|
||||||
|
|
||||||
## Logic
|
|
||||||
|
|
||||||
Go templates provide the most basic iteration and conditional logic.
|
|
||||||
|
|
||||||
### Iteration
|
|
||||||
|
|
||||||
Just like in go, the go templates make heavy use of range to iterate over
|
|
||||||
a map, array or slice. The following are different examples of how to use
|
|
||||||
range.
|
|
||||||
|
|
||||||
**Example 1: Using Context**
|
|
||||||
|
|
||||||
{{ range array }}
|
|
||||||
{{ . }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring value variable name**
|
|
||||||
|
|
||||||
{{range $element := array}}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 2: Declaring key and value variable name**
|
|
||||||
|
|
||||||
{{range $index, $element := array}}
|
|
||||||
{{ $index }}
|
|
||||||
{{ $element }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
### Conditionals
|
|
||||||
|
|
||||||
If, else, with, or, & and provide the framework for handling conditional
|
|
||||||
logic in Go Templates. Like range, each statement is closed with `end`.
|
|
||||||
|
|
||||||
|
|
||||||
Go Templates treat the following values as false:
|
|
||||||
|
|
||||||
* false
|
|
||||||
* 0
|
|
||||||
* any array, slice, map, or string of length zero
|
|
||||||
|
|
||||||
**Example 1: If**
|
|
||||||
|
|
||||||
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 2: If -> Else**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{else}}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
**Example 3: And & Or**
|
|
||||||
|
|
||||||
{{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
|
|
||||||
**Example 4: With**
|
|
||||||
|
|
||||||
An alternative way of writing "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent.
|
|
||||||
|
|
||||||
The first example above could be simplified as:
|
|
||||||
|
|
||||||
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
|
||||||
|
|
||||||
**Example 5: If -> Else If**
|
|
||||||
|
|
||||||
{{ if isset .Params "alt" }}
|
|
||||||
{{ index .Params "alt" }}
|
|
||||||
{{ else if isset .Params "caption" }}
|
|
||||||
{{ index .Params "caption" }}
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
## Pipes
|
|
||||||
|
|
||||||
One of the most powerful components of go templates is the ability to
|
|
||||||
stack actions one after another. This is done by using pipes. Borrowed
|
|
||||||
from unix pipes, the concept is simple, each pipeline's output becomes the
|
|
||||||
input of the following pipe.
|
|
||||||
|
|
||||||
Because of the very simple syntax of go templates, the pipe is essential
|
|
||||||
to being able to chain together function calls. One limitation of the
|
|
||||||
pipes is that they only can work with a single value and that value
|
|
||||||
becomes the last parameter of the next pipeline.
|
|
||||||
|
|
||||||
A few simple examples should help convey how to use the pipe.
|
|
||||||
|
|
||||||
**Example 1 :**
|
|
||||||
|
|
||||||
{{ if eq 1 1 }} Same {{ end }}
|
|
||||||
|
|
||||||
is the same as
|
|
||||||
|
|
||||||
{{ eq 1 1 | if }} Same {{ end }}
|
|
||||||
|
|
||||||
It does look odd to place the if at the end, but it does provide a good
|
|
||||||
illustration of how to use the pipes.
|
|
||||||
|
|
||||||
**Example 2 :**
|
|
||||||
|
|
||||||
{{ index .Params "disqus_url" | html }}
|
|
||||||
|
|
||||||
Access the page parameter called "disqus_url" and escape the HTML.
|
|
||||||
|
|
||||||
**Example 3 :**
|
|
||||||
|
|
||||||
{{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Could be rewritten as
|
|
||||||
|
|
||||||
{{ isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" | if }}
|
|
||||||
Stuff Here
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
## Context (aka. the dot)
|
|
||||||
|
|
||||||
The most easily overlooked concept to understand about go templates is that {{ . }}
|
|
||||||
always refers to the current context. In the top level of your template this
|
|
||||||
will be the data set made available to it. Inside of a iteration it will have
|
|
||||||
the value of the current item. When inside of a loop the context has changed. .
|
|
||||||
will no longer refer to the data available to the entire page. If you need to
|
|
||||||
access this from within the loop you will likely want to set it to a variable
|
|
||||||
instead of depending on the context.
|
|
||||||
|
|
||||||
**Example:**
|
|
||||||
|
|
||||||
{{ $title := .Site.Title }}
|
|
||||||
{{ range .Params.tags }}
|
|
||||||
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">{{ . }}</a> - {{ $title }} </li>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
Notice how once we have entered the loop the value of {{ . }} has changed. We
|
|
||||||
have defined a variable outside of the loop so we have access to it from within
|
|
||||||
the loop.
|
|
||||||
|
|
||||||
# Hugo Parameters
|
|
||||||
|
|
||||||
Hugo provides the option of passing values to the template language
|
|
||||||
through the site configuration (for sitewide values), or through the meta
|
|
||||||
data of each specific piece of content. You can define any values of any
|
|
||||||
type (supported by your front matter/config format) and use them however
|
|
||||||
you want to inside of your templates.
|
|
||||||
|
|
||||||
|
|
||||||
## Using Content (page) Parameters
|
|
||||||
|
|
||||||
In each piece of content you can provide variables to be used by the
|
|
||||||
templates. This happens in the [front matter](/content/front-matter).
|
|
||||||
|
|
||||||
An example of this is used in this documentation site. Most of the pages
|
|
||||||
benefit from having the table of contents provided. Sometimes the TOC just
|
|
||||||
doesn't make a lot of sense. We've defined a variable in our front matter
|
|
||||||
of some pages to turn off the TOC from being displayed.
|
|
||||||
|
|
||||||
Here is the example front matter:
|
|
||||||
|
|
||||||
```
|
|
||||||
---
|
|
||||||
title: "Permalinks"
|
|
||||||
date: "2013-11-18"
|
|
||||||
aliases:
|
|
||||||
- "/doc/permalinks/"
|
|
||||||
groups: ["extras"]
|
|
||||||
groups_weight: 30
|
|
||||||
notoc: true
|
|
||||||
---
|
|
||||||
```
|
|
||||||
|
|
||||||
Here is the corresponding code inside of the template:
|
|
||||||
|
|
||||||
{{ if not .Params.notoc }}
|
|
||||||
<div id="toc" class="well col-md-4 col-sm-6">
|
|
||||||
{{ .TableOfContents }}
|
|
||||||
</div>
|
|
||||||
{{ end }}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Using Site (config) Parameters
|
|
||||||
In your top-level configuration file (eg, `config.yaml`) you can define site
|
|
||||||
parameters, which are values which will be available to you in chrome.
|
|
||||||
|
|
||||||
For instance, you might declare:
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
params:
|
|
||||||
CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved."
|
|
||||||
TwitterUser: "spf13"
|
|
||||||
SidebarRecentLimit: 5
|
|
||||||
```
|
|
||||||
|
|
||||||
Within a footer layout, you might then declare a `<footer>` which is only
|
|
||||||
provided if the `CopyrightHTML` parameter is provided, and if it is given,
|
|
||||||
you would declare it to be HTML-safe, so that the HTML entity is not escaped
|
|
||||||
again. This would let you easily update just your top-level config file each
|
|
||||||
January 1st, instead of hunting through your templates.
|
|
||||||
|
|
||||||
```
|
|
||||||
{{if .Site.Params.CopyrightHTML}}<footer>
|
|
||||||
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
|
||||||
</footer>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
An alternative way of writing the "if" and then referencing the same value
|
|
||||||
is to use "with" instead. With rebinds the context `.` within its scope,
|
|
||||||
and skips the block if the variable is absent:
|
|
||||||
|
|
||||||
```
|
|
||||||
{{with .Site.Params.TwitterUser}}<span class="twitter">
|
|
||||||
<a href="https://twitter.com/{{.}}" rel="author">
|
|
||||||
<img src="/images/twitter.png" width="48" height="48" title="Twitter: {{.}}"
|
|
||||||
alt="Twitter"></a>
|
|
||||||
</span>{{end}}
|
|
||||||
```
|
|
||||||
|
|
||||||
Finally, if you want to pull "magic constants" out of your layouts, you can do
|
|
||||||
so, such as in this example:
|
|
||||||
|
|
||||||
```
|
|
||||||
<nav class="recent">
|
|
||||||
<h1>Recent Posts</h1>
|
|
||||||
<ul>{{range first .Site.Params.SidebarRecentLimit .Site.Recent}}
|
|
||||||
<li><a href="{{.RelPermalink}}">{{.Title}}</a></li>
|
|
||||||
{{end}}</ul>
|
|
||||||
</nav>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
[go]: <http://golang.org/>
|
|
||||||
[gohtmltemplate]: <http://golang.org/pkg/html/template/>
|
|
||||||
@ -1,91 +0,0 @@
|
|||||||
+++
|
|
||||||
title = "Getting Started with Hugo"
|
|
||||||
description = "Goto hugo releases and download the appropriate version for your os and architecture."
|
|
||||||
tags = [
|
|
||||||
"go",
|
|
||||||
"golang",
|
|
||||||
"hugo",
|
|
||||||
"development",
|
|
||||||
]
|
|
||||||
date = "2014-04-02"
|
|
||||||
categories = [
|
|
||||||
"Development",
|
|
||||||
"golang",
|
|
||||||
]
|
|
||||||
menu = "main"
|
|
||||||
+++
|
|
||||||
|
|
||||||
## Step 1. Install Hugo
|
|
||||||
|
|
||||||
Goto [hugo releases](https://github.com/spf13/hugo/releases) and download the
|
|
||||||
appropriate version for your os and architecture.
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
Save it somewhere specific as we will be using it in the next step.
|
|
||||||
|
|
||||||
More complete instructions are available at [installing hugo](/overview/installing/)
|
|
||||||
|
|
||||||
## Step 2. Build the Docs
|
|
||||||
|
|
||||||
Hugo has its own example site which happens to also be the documentation site
|
|
||||||
you are reading right now.
|
|
||||||
|
|
||||||
Follow the following steps:
|
|
||||||
|
|
||||||
1. Clone the [hugo repository](http://github.com/spf13/hugo)
|
|
||||||
2. Go into the repo
|
|
||||||
3. Run hugo in server mode and build the docs
|
|
||||||
4. Open your browser to http://localhost:1313
|
|
||||||
|
|
||||||
Corresponding pseudo commands:
|
|
||||||
|
|
||||||
git clone https://github.com/spf13/hugo
|
|
||||||
cd hugo
|
|
||||||
/path/to/where/you/installed/hugo server --source=./docs
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
Once you've gotten here, follow along the rest of this page on your local build.
|
|
||||||
|
|
||||||
## Step 3. Change the docs site
|
|
||||||
|
|
||||||
Stop the Hugo process by hitting ctrl+c.
|
|
||||||
|
|
||||||
Now we are going to run hugo again, but this time with hugo in watch mode.
|
|
||||||
|
|
||||||
/path/to/hugo/from/step/1/hugo server --source=./docs --watch
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 27 ms
|
|
||||||
> Web Server is available at http://localhost:1313
|
|
||||||
> Watching for changes in /Users/spf13/Code/hugo/docs/content
|
|
||||||
> Press ctrl+c to stop
|
|
||||||
|
|
||||||
|
|
||||||
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
|
||||||
content pages. How about changing this very file to *fix the typo*. How about changing this very file to *fix the typo*.
|
|
||||||
|
|
||||||
Content files are found in `docs/content/`. Unless otherwise specified, files
|
|
||||||
are located at the same relative location as the url, in our case
|
|
||||||
`docs/content/overview/quickstart.md`.
|
|
||||||
|
|
||||||
Change and save this file.. Notice what happened in your terminal.
|
|
||||||
|
|
||||||
> Change detected, rebuilding site
|
|
||||||
|
|
||||||
> 29 pages created
|
|
||||||
> 0 tags index created
|
|
||||||
> in 26 ms
|
|
||||||
|
|
||||||
Refresh the browser and observe that the typo is now fixed.
|
|
||||||
|
|
||||||
Notice how quick that was. Try to refresh the site before it's finished building.. I double dare you.
|
|
||||||
Having nearly instant feedback enables you to have your creativity flow without waiting for long builds.
|
|
||||||
|
|
||||||
## Step 4. Have fun
|
|
||||||
|
|
||||||
The best way to learn something is to play with it.
|
|
||||||
@ -1,164 +0,0 @@
|
|||||||
---
|
|
||||||
date: 2014-03-10
|
|
||||||
linktitle: Migrating from Jekyll
|
|
||||||
menu:
|
|
||||||
main:
|
|
||||||
parent: tutorials
|
|
||||||
prev: /tutorials/mathjax
|
|
||||||
title: Migrate to Hugo from Jekyll
|
|
||||||
description: Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output.
|
|
||||||
weight: 10
|
|
||||||
---
|
|
||||||
|
|
||||||
## Move static content to `static`
|
|
||||||
Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output.
|
|
||||||
|
|
||||||
<!--more-->
|
|
||||||
|
|
||||||
Hugo keeps all static content under `static`. You should therefore move it all there.
|
|
||||||
With Jekyll, something that looked like
|
|
||||||
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
should become
|
|
||||||
|
|
||||||
▾ <root>/
|
|
||||||
▾ static/
|
|
||||||
▾ images/
|
|
||||||
logo.png
|
|
||||||
|
|
||||||
Additionally, you'll want any files that should reside at the root (such as `CNAME`) to be moved to `static`.
|
|
||||||
|
|
||||||
## Create your Hugo configuration file
|
|
||||||
Hugo can read your configuration as JSON, YAML or TOML. Hugo supports parameters custom configuration too. Refer to the [Hugo configuration documentation](/overview/configuration/) for details.
|
|
||||||
|
|
||||||
## Set your configuration publish folder to `_site`
|
|
||||||
The default is for Jekyll to publish to `_site` and for Hugo to publish to `public`. If, like me, you have [`_site` mapped to a git submodule on the `gh-pages` branch](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.html), you'll want to do one of two alternatives:
|
|
||||||
|
|
||||||
1. Change your submodule to point to map `gh-pages` to public instead of `_site` (recommended).
|
|
||||||
|
|
||||||
git submodule deinit _site
|
|
||||||
git rm _site
|
|
||||||
git submodule add -b gh-pages git@github.com:your-username/your-repo.git public
|
|
||||||
|
|
||||||
2. Or, change the Hugo configuration to use `_site` instead of `public`.
|
|
||||||
|
|
||||||
{
|
|
||||||
..
|
|
||||||
"publishdir": "_site",
|
|
||||||
..
|
|
||||||
}
|
|
||||||
|
|
||||||
## Convert Jekyll templates to Hugo templates
|
|
||||||
That's the bulk of the work right here. The documentation is your friend. You should refer to [Jekyll's template documentation](http://jekyllrb.com/docs/templates/) if you need to refresh your memory on how you built your blog and [Hugo's template](/layout/templates/) to learn Hugo's way.
|
|
||||||
|
|
||||||
As a single reference data point, converting my templates for [heyitsalex.net](http://heyitsalex.net/) took me no more than a few hours.
|
|
||||||
|
|
||||||
## Convert Jekyll plugins to Hugo shortcodes
|
|
||||||
Jekyll has [plugins](http://jekyllrb.com/docs/plugins/); Hugo has [shortcodes](/doc/shortcodes/). It's fairly trivial to do a port.
|
|
||||||
|
|
||||||
### Implementation
|
|
||||||
As an example, I was using a custom [`image_tag`](https://github.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc06908ec/_plugins/image_tag.rb) plugin to generate figures with caption when running Jekyll. As I read about shortcodes, I found Hugo had a nice built-in shortcode that does exactly the same thing.
|
|
||||||
|
|
||||||
Jekyll's plugin:
|
|
||||||
|
|
||||||
```ruby
|
|
||||||
module Jekyll
|
|
||||||
class ImageTag < Liquid::Tag
|
|
||||||
@url = nil
|
|
||||||
@caption = nil
|
|
||||||
@class = nil
|
|
||||||
@link = nil
|
|
||||||
// Patterns
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION =
|
|
||||||
IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK = /(\w+)(\s+)((https?:\/\/|\/)(\S+))(\s+)"(.*?)"(\s+)->((https?:\/\/|\/)(\S+))(\s*)/i
|
|
||||||
IMAGE_URL_WITH_CAPTION = /((https?:\/\/|\/)(\S+))(\s+)"(.*?)"/i
|
|
||||||
IMAGE_URL_WITH_CLASS = /(\w+)(\s+)((https?:\/\/|\/)(\S+))/i
|
|
||||||
IMAGE_URL = /((https?:\/\/|\/)(\S+))/i
|
|
||||||
def initialize(tag_name, markup, tokens)
|
|
||||||
super
|
|
||||||
if markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION_AND_LINK
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
@link = $9
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS_AND_CAPTION
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
@caption = $7
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CAPTION
|
|
||||||
@url = $1
|
|
||||||
@caption = $5
|
|
||||||
elsif markup =~ IMAGE_URL_WITH_CLASS
|
|
||||||
@class = $1
|
|
||||||
@url = $3
|
|
||||||
elsif markup =~ IMAGE_URL
|
|
||||||
@url = $1
|
|
||||||
end
|
|
||||||
end
|
|
||||||
def render(context)
|
|
||||||
if @class
|
|
||||||
source = "<figure class='#{@class}'>"
|
|
||||||
else
|
|
||||||
source = "<figure>"
|
|
||||||
end
|
|
||||||
if @link
|
|
||||||
source += "<a href=\"#{@link}\">"
|
|
||||||
end
|
|
||||||
source += "<img src=\"#{@url}\">"
|
|
||||||
if @link
|
|
||||||
source += "</a>"
|
|
||||||
end
|
|
||||||
source += "<figcaption>#{@caption}</figcaption>" if @caption
|
|
||||||
source += "</figure>"
|
|
||||||
source
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Liquid::Template.register_tag('image', Jekyll::ImageTag)
|
|
||||||
```
|
|
||||||
|
|
||||||
is written as this Hugo shortcode:
|
|
||||||
|
|
||||||
<!-- image -->
|
|
||||||
<figure {{ with .Get "class" }}class="{{.}}"{{ end }}>
|
|
||||||
{{ with .Get "link"}}<a href="{{.}}">{{ end }}
|
|
||||||
<img src="{{ .Get "src" }}" {{ if or (.Get "alt") (.Get "caption") }}alt="{{ with .Get "alt"}}{{.}}{{else}}{{ .Get "caption" }}{{ end }}"{{ end }} />
|
|
||||||
{{ if .Get "link"}}</a>{{ end }}
|
|
||||||
{{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
|
|
||||||
<figcaption>{{ if isset .Params "title" }}
|
|
||||||
{{ .Get "title" }}{{ end }}
|
|
||||||
{{ if or (.Get "caption") (.Get "attr")}}<p>
|
|
||||||
{{ .Get "caption" }}
|
|
||||||
{{ with .Get "attrlink"}}<a href="{{.}}"> {{ end }}
|
|
||||||
{{ .Get "attr" }}
|
|
||||||
{{ if .Get "attrlink"}}</a> {{ end }}
|
|
||||||
</p> {{ end }}
|
|
||||||
</figcaption>
|
|
||||||
{{ end }}
|
|
||||||
</figure>
|
|
||||||
<!-- image -->
|
|
||||||
|
|
||||||
### Usage
|
|
||||||
I simply changed:
|
|
||||||
|
|
||||||
{% image full http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg "One of my favorite touristy-type photos. I secretly waited for the good light while we were "having fun" and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." ->http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/ %}
|
|
||||||
|
|
||||||
to this (this example uses a slightly extended version named `fig`, different than the built-in `figure`):
|
|
||||||
|
|
||||||
{{%/* fig class="full" src="http://farm5.staticflickr.com/4136/4829260124_57712e570a_o_d.jpg" title="One of my favorite touristy-type photos. I secretly waited for the good light while we were having fun and took this. Only regret: a stupid pole in the top-left corner of the frame I had to clumsily get rid of at post-processing." link="http://www.flickr.com/photos/alexnormand/4829260124/in/set-72157624547713078/" */%}}
|
|
||||||
|
|
||||||
As a bonus, the shortcode named parameters are, arguably, more readable.
|
|
||||||
|
|
||||||
## Finishing touches
|
|
||||||
### Fix content
|
|
||||||
Depending on the amount of customization that was done with each post with Jekyll, this step will require more or less effort. There are no hard and fast rules here except that `hugo server --watch` is your friend. Test your changes and fix errors as needed.
|
|
||||||
|
|
||||||
### Clean up
|
|
||||||
You'll want to remove the Jekyll configuration at this point. If you have anything else that isn't used, delete it.
|
|
||||||
|
|
||||||
## A practical example in a diff
|
|
||||||
[Hey, it's Alex](http://heyitsalex.net/) was migrated in less than a _father-with-kids day_ from Jekyll to Hugo. You can see all the changes (and screw-ups) by looking at this [diff](https://github.com/alexandre-normand/alexandre-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b81495423294208cc74d610).
|
|
||||||
Loading…
Reference in New Issue