Install hello-friend-ng theme
This commit is contained in:
parent
f7627ba6ea
commit
f6b2c20086
639 changed files with 33880 additions and 0 deletions
File diff suppressed because it is too large
Load diff
File diff suppressed because it is too large
Load diff
|
|
@ -0,0 +1,352 @@
|
|||
+++
|
||||
categories = ["Go"]
|
||||
date = "2014-04-02"
|
||||
description = ""
|
||||
featured = "pic02.jpg"
|
||||
featuredalt = ""
|
||||
featuredpath = "date"
|
||||
linktitle = ""
|
||||
slug = "Introduction aux modeles Hugo"
|
||||
title = "Introduction aux modèles (Hu)go"
|
||||
type = ["posts","post"]
|
||||
[ author ]
|
||||
name = "Michael Henderson"
|
||||
+++
|
||||
|
||||
Hugo utilise l'excellente librairie [go][] [html/template][gohtmltemplate] pour
|
||||
son moteur de modèles. c'est un moteur extrêmement léger qui offre un très petit
|
||||
nombre de fonctions logiques. À notre expérience, c'est juste ce qu'il faut pour
|
||||
créer un bon site web statique. Si vous avez déjà utilisé d'autre moteurs de
|
||||
modèles pour différents langages ou frameworks, vous allez retrouver beaucoup de
|
||||
similitudes avec les modèles go.
|
||||
|
||||
Ce document est une introduction sur l'utilisation de Go templates. La
|
||||
[documentation go][gohtmltemplate] fourni plus de détails.
|
||||
|
||||
## Introduction aux modèles Go
|
||||
|
||||
Go templates fournit un langage de modèles très simple. Il adhère à la
|
||||
conviction que les modèles ou les vues doivent avoir une logique des plus
|
||||
élémentaires. L'une des conséquences de cette simplicité est que les modèles
|
||||
seront plus rapides a être analysés.
|
||||
|
||||
Une caractéristique unique de Go templates est qu'il est conscient du contenu.
|
||||
Les variables et le contenu va être nettoyé suivant le contexte d'utilisation.
|
||||
Plus de détails sont disponibles dans la [documentation go][gohtmltemplate].
|
||||
|
||||
## Syntaxe basique
|
||||
|
||||
Les modèles en langage Go sont des fichiers HTML avec l'ajout de variables et
|
||||
fonctions.
|
||||
|
||||
**Les variables Go et les fonctions sont accessibles avec {{ }}**
|
||||
|
||||
|
||||
Accès à une variable prédéfinie "foo":
|
||||
|
||||
{{ foo }}
|
||||
|
||||
**Les paramètres sont séparés par des espaces**
|
||||
|
||||
Appel de la fonction add avec 1 et 2 en argument**
|
||||
|
||||
{{ add 1 2 }}
|
||||
|
||||
**Les méthodes et les champs sont accessibles par un point**
|
||||
|
||||
Accès au paramètre de la page "bar"
|
||||
|
||||
{{ .Params.bar }}
|
||||
|
||||
**Les parenthèses peuvent être utilisées pour grouper des éléments ensemble**
|
||||
```
|
||||
{{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }}
|
||||
```
|
||||
|
||||
## Variables
|
||||
|
||||
Chaque modèle go a une structure (objet) mis à sa disposition. Avec Hugo, à
|
||||
chaque modèle est passé soit une page, soit une structure de nœud, suivant quel
|
||||
type de page vous rendez. Plus de détails sont disponibles sur la page des
|
||||
[variables](/layout/variables).
|
||||
|
||||
Une variable est accessible par son nom.
|
||||
|
||||
<title>{{ .Title }}</title>
|
||||
|
||||
Les variables peuvent également être définies et appelées.
|
||||
|
||||
{{ $address := "123 Main St."}}
|
||||
{{ $address }}
|
||||
|
||||
|
||||
## Functions
|
||||
|
||||
Go templace est livré avec quelques fonctions qui fournissent des
|
||||
fonctionnalités basiques. Le système de Go template fourni également un
|
||||
mécanisme permettant aux applications d'étendre les fonctions disponible. Les
|
||||
[fonctions de modèle Hugo](/layout/functions) fourni quelques fonctionnalités
|
||||
supplémentaires que nous espérons qu'elles seront utiles pour vos sites web.
|
||||
Les functions sont appelées en utilisant leur nom suivi par les paramètres
|
||||
requis séparés par des espaces. Des fonctions de modèles ne peuvent pas être
|
||||
ajoutées sans recompiler Hugo.
|
||||
|
||||
**Exemple:**
|
||||
|
||||
{{ add 1 2 }}
|
||||
|
||||
## Inclusions
|
||||
|
||||
Lorsque vous incluez un autre modèle, vous devez y passer les données qu'il sera
|
||||
en mesure d'accèder. Pour passer le contexte actuel, pensez à ajouter un point.
|
||||
La localisation du modèle sera toujours à partir du répertoire /layout/ dans
|
||||
Hugo.
|
||||
|
||||
**Exemple:**
|
||||
|
||||
{{ template "chrome/header.html" . }}
|
||||
|
||||
|
||||
## Logique
|
||||
|
||||
Go templates fourni les itérations et la logique conditionnèle des plus basique.
|
||||
|
||||
### Itération
|
||||
|
||||
Comme en go, les modèles go utilisent fortement *range* pour itérer dans une
|
||||
map, un array ou un slice. Les exemples suivant montre différentes façons
|
||||
d'utiliser *range*
|
||||
|
||||
**Exemple 1: En utilisant le context**
|
||||
|
||||
{{ range array }}
|
||||
{{ . }}
|
||||
{{ end }}
|
||||
|
||||
**Exemple 2: En déclarant un nom de variable**
|
||||
|
||||
{{range $element := array}}
|
||||
{{ $element }}
|
||||
{{ end }}
|
||||
|
||||
**Exemple 2: En déclarant un nom de varialbe pour la clé et la valeur**
|
||||
|
||||
{{range $index, $element := array}}
|
||||
{{ $index }}
|
||||
{{ $element }}
|
||||
{{ end }}
|
||||
|
||||
### Conditions
|
||||
|
||||
*If*, *else*, *with*, *or*, *&*, *and* fournissent la base pour la logique
|
||||
conditionnelle avec Go templates. Comme *range*, chaque déclaration est fermé
|
||||
avec `end`.
|
||||
|
||||
Go templates considère les valeurs suivante comme *false* :
|
||||
|
||||
* false
|
||||
* 0
|
||||
* tout array, slice, map ou chaine d'une longueur de zéro
|
||||
|
||||
**Exemple 1: If**
|
||||
|
||||
{{ if isset .Params "title" }}<h4>{{ index .Params "title" }}</h4>{{ end }}
|
||||
|
||||
**Exemple 2: If -> Else**
|
||||
|
||||
{{ if isset .Params "alt" }}
|
||||
{{ index .Params "alt" }}
|
||||
{{else}}
|
||||
{{ index .Params "caption" }}
|
||||
{{ end }}
|
||||
|
||||
**Exemple 3: And & Or**
|
||||
```
|
||||
{{ if and (or (isset .Params "title") (isset .Params "caption"))
|
||||
(isset .Params "attr")}}
|
||||
```
|
||||
**Exemple 4: With**
|
||||
|
||||
Une manière alternative d'écrire un "if" et de référencer cette même valeur est
|
||||
d'utiliser "with". Cela permet de remplacer le contexte `.` par cet valeur et
|
||||
saute le bloc si la variable est absente.
|
||||
|
||||
Le premier exemple peut être simplifié à ceci :
|
||||
|
||||
{{ with .Params.title }}<h4>{{ . }}</h4>{{ end }}
|
||||
|
||||
**Exemple 5: If -> Else If**
|
||||
|
||||
{{ if isset .Params "alt" }}
|
||||
{{ index .Params "alt" }}
|
||||
{{ else if isset .Params "caption" }}
|
||||
{{ index .Params "caption" }}
|
||||
{{ end }}
|
||||
|
||||
## *Pipes*
|
||||
|
||||
L'un des composants le plus puissant de Go templates est la capacité d'empiler
|
||||
les action l'une après l'autre. Cela est fait en utilisant les *pipes*.
|
||||
Empruntés aux *pipes* unix, le concept est simple. Chaque sortie de *pipeline*
|
||||
devient l'entrée du *pipe* suivant.
|
||||
|
||||
À cause de la syntaxe très simple de Go templates, le *pipe* est essentiel pour
|
||||
être capable d'enchainer les appels de fonctions. Une limitation des *pipes*
|
||||
est qu'il ne peuvent fonctionner seulement avec une seule valeur et cette valeur
|
||||
devient le dernier paramètre du prochain *pipeline*.
|
||||
|
||||
Quelques exemples simple devrait vous aider à comprendre comment utiliser les
|
||||
*pipes*.
|
||||
|
||||
**Exemple 1 :**
|
||||
|
||||
{{ if eq 1 1 }} Same {{ end }}
|
||||
|
||||
est identique à
|
||||
|
||||
{{ eq 1 1 | if }} Same {{ end }}
|
||||
|
||||
|
||||
Il semble étrange de placer le *if* à la fin, mais il fournit une bonne
|
||||
illustration de la façon d'utiliser les tuyaux.
|
||||
|
||||
**Exemple 2 :**
|
||||
|
||||
{{ index .Params "disqus_url" | html }}
|
||||
|
||||
Accès au paramètre de page nommé "disqus_url" et échappement du HTML
|
||||
|
||||
**Exemple 3 :**
|
||||
```
|
||||
{{ if or (or (isset .Params "title") (isset .Params "caption"))
|
||||
(isset .Params "attr")}}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
```
|
||||
Peut être réécrit en
|
||||
|
||||
```
|
||||
{{ isset .Params "caption" | or isset .Params "title" |
|
||||
or isset .Params "attr" | if }}
|
||||
Stuff Here
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
## Contexte (alias. le point)
|
||||
|
||||
Le concept le plus facilement négligé pour comprendre les modèles go est que
|
||||
{{ . }} fait toujours référence au contexte actuel. Dans le plus haut niveau de
|
||||
votre modèle, ce sera l'ensemble des données mis à votre disposition. Dans une
|
||||
itération, ce sera la valeur de l'élément actuel. Enfin, dans une boucle, le
|
||||
contexte change. . ne fera plus référence aux données disponibles dans la page
|
||||
entière. Si vous avez besoin y d'accèder depuis l'intérieur d'une boucle, il est
|
||||
judicieux d'y définir comme variable au lieu de dépendre du contexte.
|
||||
|
||||
**Exemple:**
|
||||
```
|
||||
{{ $title := .Site.Title }}
|
||||
{{ range .Params.tags }}
|
||||
<li> <a href="{{ $baseurl }}/tags/{{ . | urlize }}">
|
||||
{{ . }}</a> - {{ $title }} </li>
|
||||
{{ end }}
|
||||
```
|
||||
|
||||
Notez que, une fois que nous sommes entrés dans la boucle, la valeur de
|
||||
{{ . }} a changée. Nous avons défini une variable en dehors de la boucle, afin
|
||||
d'y avoir accès dans la boucle.
|
||||
|
||||
# Les Paramètres d'Hugo
|
||||
|
||||
Hugo fournit l'option de passer des valeurs au modèle depuis la configuration du
|
||||
site, ou depuis les métadonnées de chaque partie du contenu. Vous pouvez définir
|
||||
n'importe quelle valeur de n'importe quel type (supporté par votre section
|
||||
liminaire / format de configuration) et les utiliser comme vous le souhaitez
|
||||
dans votre modèle.
|
||||
|
||||
## Utiliser les paramètres de contenu (page)
|
||||
|
||||
Dans chaque partie du contenu, vous pouvez fournir des variables pour être
|
||||
utilisées par le modèle. Cela se passe dans la
|
||||
[section liminaire](/content/front-matter).
|
||||
|
||||
Un exemple de cela est utilisé par ce site de documentation. La plupart des
|
||||
pages bénéficient de la présentation de la table des matières. Quelques fois,
|
||||
la table des matières n'a pas beaucoup de sens. Nous avons défini une variable
|
||||
dans notre section liminaire de quelques pages pour désactiver la table des
|
||||
matières.
|
||||
|
||||
Ceci est un exemple de section liminaire :
|
||||
|
||||
```
|
||||
---
|
||||
title: "Permalinks"
|
||||
date: "2013-11-18"
|
||||
aliases:
|
||||
- "/doc/permalinks/"
|
||||
groups: ["extras"]
|
||||
groups_weight: 30
|
||||
notoc: true
|
||||
---
|
||||
```
|
||||
|
||||
Ceci est le code correspondant dans le modèle :
|
||||
|
||||
{{ if not .Params.notoc }}
|
||||
<div id="toc" class="well col-md-4 col-sm-6">
|
||||
{{ .TableOfContents }}
|
||||
</div>
|
||||
{{ end }}
|
||||
|
||||
|
||||
|
||||
## Utiliser les paramètres de site (config)
|
||||
|
||||
Dans votre configuration de plus haut niveau (ex `config.yaml`), vous pouvez
|
||||
définir des paramètres de site, dont les valeurs vous seront accessibles.
|
||||
|
||||
Pour les instances, vous pourriez délarer :
|
||||
|
||||
```yaml
|
||||
params:
|
||||
CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved."
|
||||
TwitterUser: "spf13"
|
||||
SidebarRecentLimit: 5
|
||||
```
|
||||
|
||||
Avec un pied de page, vous devriez déclarer un `<footer>` qui est affiché
|
||||
seulement si le paramètre `CopyrightHTML` est déclaré, et si il l'est, vous
|
||||
devriez le déclarer comme HTML-safe, afin d'éviter d'échapper les entités HTML.
|
||||
Cela vous permettra de le modifier facilement dans votre configuration au lieu
|
||||
de le chercher dans votre modèle.
|
||||
|
||||
```
|
||||
{{if .Site.Params.CopyrightHTML}}<footer>
|
||||
<div class="text-center">{{.Site.Params.CopyrightHTML | safeHtml}}</div>
|
||||
</footer>{{end}}
|
||||
```
|
||||
Une alternative au "if" et d'appeler la même valeur est d'utiliser "with". Cela
|
||||
modifiera le contexte et passera le bloc si la variable est absente :
|
||||
|
||||
```
|
||||
{{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}}
|
||||
```
|
||||
|
||||
Enfin, si vous souhaitez extraire des "constantes magiques" de vos mises en
|
||||
page, vous pouvez le faire comme dans l'exemple suivant :
|
||||
|
||||
```
|
||||
<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/>
|
||||
|
|
@ -0,0 +1,347 @@
|
|||
+++
|
||||
title = "(Hu)go Template Primer"
|
||||
description = ""
|
||||
type = ["posts","post"]
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"templates",
|
||||
"themes",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
series = ["Hugo 101"]
|
||||
[ author ]
|
||||
name = "Hugo Authors"
|
||||
+++
|
||||
|
||||
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. 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
|
||||
|
||||
Golang 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]: https://golang.org/
|
||||
[gohtmltemplate]: https://golang.org/pkg/html/template/
|
||||
|
|
@ -0,0 +1,99 @@
|
|||
+++
|
||||
categories = ["Hugo"]
|
||||
date = "2014-04-02"
|
||||
description = ""
|
||||
featured = "pic03.jpg"
|
||||
featuredalt = "Pic 3"
|
||||
featuredpath = "date"
|
||||
linktitle = ""
|
||||
slug = "Debuter avec Hugo"
|
||||
title = "Débuter avec Hugo"
|
||||
type = "post"
|
||||
[ author ]
|
||||
name = "Hugo Authors"
|
||||
+++
|
||||
|
||||
## Étape 1. Installer Hugo
|
||||
|
||||
Allez sur la page de téléchargements de
|
||||
[hugo](https://github.com/spf13/hugo/releases) et téléchargez la version
|
||||
appropriée à votre système d'exploitation et votre architecture.
|
||||
|
||||
Sauvegardez le fichier téléchargé à un endroit précis, afin de l'utiliser dans
|
||||
l'étape suivante.
|
||||
|
||||
Des informations plus complètes sont disponibles sur la page
|
||||
[installing hugo](/overview/installing/)
|
||||
<!--more-->
|
||||
|
||||
## Étape 2. Compilez la documentation
|
||||
|
||||
Hugo possède son propre site d'exemple qui se trouve être également le site que
|
||||
vous lisez actuellement.
|
||||
|
||||
Suivez les instructions suivante :
|
||||
|
||||
1. Clonez le [dépôt de hugo](http://github.com/spf13/hugo)
|
||||
2. Allez dans ce dépôt
|
||||
3. Lancez Hugo en mode serveur et compilez la documentation
|
||||
4. Ouvrez votre navigateur sur http://localhost:1313
|
||||
|
||||
Voici les commandes génériques correspondantes :
|
||||
|
||||
git clone https://github.com/spf13/hugo
|
||||
cd hugo
|
||||
/chemin/ou/vous/avez/installe/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
|
||||
|
||||
Lorsque vous avez cela, continuez le reste de ce guide sur votre version locale.
|
||||
|
||||
## Étape 3. Changer le site de documentation
|
||||
|
||||
Arrêtez le processus de Hugo en pressant ctrl+c.
|
||||
|
||||
Maintenant, nous allons relancer hugo, mais cette fois avec Hugo en mode de
|
||||
surveillance.
|
||||
|
||||
/chemin/vers/hugo/de/l-etape/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
|
||||
|
||||
Ouvrez votre [éditeur favori](https://vim.spf13.com) et changer l'une des
|
||||
sources des pages de contenu.
|
||||
Open your [favorite editor](http://vim.spf13.com) and change one of the source
|
||||
content pages. Que diriez-vous de modifier ce fichier pour *résoudre une faute
|
||||
de typo*.
|
||||
|
||||
Les fichiers de contenu peuvent être trouvés dans `docs/content/`. Sauf
|
||||
indication contraire, les fichiers sont situés au même emplacement relatif que
|
||||
l'URL, dans notre cas `docs/content/overview/quickstart.md`.
|
||||
|
||||
Modifiez et sauvegardez ce fichier. Notez ce qu'il se passe dans le terminal.
|
||||
|
||||
> Change detected, rebuilding site
|
||||
|
||||
> 29 pages created
|
||||
> 0 tags index created
|
||||
> in 26 ms
|
||||
|
||||
Rechargez la page dans votre navigateur et voyez que le problème de typo est
|
||||
maintenant résolu.
|
||||
|
||||
Notez à quel point cela a été rapide. Essayez de recharger le site avant qu'il
|
||||
soit fini de compiler.
|
||||
Notice how quick that was. Try to refresh the site before it's finished
|
||||
building. Je paris que vous n'y arrivez pas.
|
||||
Le fait d'avoir des réactions presque instantanées vous permet d'avoir votre
|
||||
créativité fluide sans avoir à attendre de longues compilations.
|
||||
|
||||
## Step 4. Amusez-vous
|
||||
|
||||
Le meilleur moyen d'apprendre quelque chose est de s'amuser avec.
|
||||
|
|
@ -0,0 +1,92 @@
|
|||
+++
|
||||
title = "Getting Started with Hugo"
|
||||
description = ""
|
||||
type = ["posts","post"]
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"hugo",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
series = ["Hugo 101"]
|
||||
[ author ]
|
||||
name = "Hugo Authors"
|
||||
+++
|
||||
|
||||
## Step 1. Install Hugo
|
||||
|
||||
Go to [Hugo releases](https://github.com/spf13/hugo/releases) and download the
|
||||
appropriate version for your OS and architecture.
|
||||
|
||||
Save it somewhere specific as we will be using it in the next step.
|
||||
|
||||
More complete instructions are available at [Install Hugo](https://gohugo.io/getting-started/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.
|
||||
|
|
@ -0,0 +1,218 @@
|
|||
+++
|
||||
categories = ["Hugo", "Jekyll"]
|
||||
date = "2014-03-10"
|
||||
description = ""
|
||||
featured = ""
|
||||
featuredalt = ""
|
||||
featuredpath = ""
|
||||
linktitle = ""
|
||||
slug = "Migrer vers Hugo depuis Jekyll"
|
||||
title = "Migrer vers Hugo depuis Jekyll"
|
||||
type = ["posts","post"]
|
||||
[ author ]
|
||||
name = "Hugo Authors"
|
||||
+++
|
||||
|
||||
## Déplacez le contenu statique vers `static`
|
||||
Jekyll a une règle comme quoi tout répertoire qui ne commence pas par `_` sera
|
||||
copié tel-quel dans le répertoire `_site`. Hugo garde tout le contenu statique
|
||||
dans le répertoire `static`. Vous devez donc déplacer tout ce type de contenu
|
||||
là-dedans. Avec Jekylll, l'arborescence ressemblant à ceci :
|
||||
|
||||
▾ <root>/
|
||||
▾ images/
|
||||
logo.png
|
||||
<!--more-->
|
||||
doit devenir
|
||||
|
||||
▾ <root>/
|
||||
▾ static/
|
||||
▾ images/
|
||||
logo.png
|
||||
|
||||
En outre, vous allez devoir déplacer tous les fichiers présents à la racine vers
|
||||
le répertoire `static`.
|
||||
|
||||
## Créez votre configuration Hugo
|
||||
Hugo peut lire votre fichier de configuration au format JSON, YAML et TOML. Hugo
|
||||
supporte également les paramètres de configuration. Plus d'informations sur la
|
||||
[documentation de configuration Hugo](/overview/configuration/)
|
||||
|
||||
## Définiez votre répertoire de publication sur `_site`
|
||||
La valeur par défaut pour Jekyll est d'utiliser le répertoire `_site` pour
|
||||
publier le contenu. Pour Hugo, le répertoire de publication est `public`. Si,
|
||||
comme moi, vous avez [lié `_site` vers un sous-module git sur la branche
|
||||
`gh-pages`](http://blog.blindgaenger.net/generate_github_pages_in_a_submodule.ht
|
||||
ml), vous allez vouloir avoir quelques alternatives :
|
||||
|
||||
1. Changez votre lien du sous-module `gh-pages` pour pointer sur public au lieu
|
||||
de `_site` (recommendé).
|
||||
|
||||
git submodule deinit _site
|
||||
git rm _site
|
||||
git submodule add -b gh-pages
|
||||
git@github.com:your-username/your-repo.git public
|
||||
|
||||
2. Ou modifiez la configuration de Hugo pour utiliser le répertoire `_site` au
|
||||
lieu de `public`.
|
||||
|
||||
{
|
||||
..
|
||||
"publishdir": "_site",
|
||||
..
|
||||
}
|
||||
|
||||
## Convertir un thème Jekyll pour Hugo
|
||||
C'est la majeure partie du travail. La documentation est votre ami.
|
||||
Vous devriez vous référer à [la documentation des thèmes de Jekyll]
|
||||
(http://jekyllrb.com/docs/templates/) si vous devez vous rafraîchir la mémoire
|
||||
sur la façon dont vous avez construit votre blog et [les thèmes de Hugo]
|
||||
(/layout/templates/) pour apprendre la manière de faire sur Hugo.
|
||||
|
||||
Pour vous donner un point de référence, la conversion du thème pour
|
||||
[heyitsalex.net](http://heyitsalex.net/) ne m'a pris que quelques heures.
|
||||
|
||||
## Convertir les extensions Jekyll vers des shortcodes Hugo
|
||||
Jekyll support les [extensions](http://jekyllrb.com/docs/plugins/); Hugo lui a
|
||||
les [shortcodes](/doc/shortcodes/). C'est assez banal les porter.
|
||||
|
||||
### Implémentation
|
||||
Comme exemple, j'utilise une extension pour avoir un [`image_tag`](https://githu
|
||||
b.com/alexandre-normand/alexandre-normand/blob/74bb12036a71334fdb7dba84e073382fc
|
||||
06908ec/_plugins/image_tag.rb) presonnalisé pour générer les images avec une
|
||||
légende sur Jekyll. J'ai vu que Hugo implémente un shortcode qui fait exactement
|
||||
la même chose.
|
||||
|
||||
Extension Jekyll :
|
||||
```
|
||||
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)
|
||||
```
|
||||
|
||||
Écrite en tant que shortcode Hugo:
|
||||
```
|
||||
<!-- 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 -->
|
||||
```
|
||||
|
||||
### Utilisation
|
||||
J'ai simplement changé :
|
||||
```
|
||||
{% 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/ %}
|
||||
```
|
||||
|
||||
pour cela (cet exemple utilise une version légèrement étendue nommée `fig`,
|
||||
différente de la `figure` intégrée) :
|
||||
|
||||
```
|
||||
{{%/* 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/" */%}}
|
||||
```
|
||||
Comme bonus, les paramètres nommés des shortcodes sont plus lisibles.
|
||||
|
||||
## Touches finales
|
||||
### Corriger le contenu
|
||||
Suivant le nombre de modifications que vous avez effectué sur chaque articles
|
||||
avec Jekyll, cette étape requierra plus ou moins d'efforts. Il n'y a pas de
|
||||
règles rigoureuses ici, si ce n'est que `hugo server --watch` est votre ami.
|
||||
Testez vos modifications et corrigez les erreurs au besoin.
|
||||
|
||||
### Nettoyez le tout
|
||||
Vous voudrez sûrement supprimer votre configuration Jekyll maintenant que tout
|
||||
est fini. Exact, pensez à supprimer tout ce qui est inutilisé.
|
||||
|
||||
## Un exemple pratique
|
||||
[Hey, it's Alex](http://heyitsalex.net/) a été migré de Jekyll vers Hugo en
|
||||
moins de temps qu'une journée père enfant. Vous pouvez trouver toutes les
|
||||
modification en regardant ce [diff](https://github.com/alexandre-normand/alexand
|
||||
re-normand/compare/869d69435bd2665c3fbf5b5c78d4c22759d7613a...b7f6605b1265e83b4b
|
||||
81495423294208cc74d610).
|
||||
|
|
@ -0,0 +1,161 @@
|
|||
---
|
||||
author:
|
||||
name: "Hugo Authors"
|
||||
date: 2014-03-10
|
||||
linktitle: Migrating from Jekyll
|
||||
title: Migrate to Hugo from Jekyll
|
||||
type:
|
||||
- post
|
||||
- posts
|
||||
weight: 10
|
||||
series:
|
||||
- Hugo 101
|
||||
aliases:
|
||||
- /blog/migrate-from-jekyll/
|
||||
---
|
||||
|
||||
## Move static content to `static`
|
||||
Jekyll has a rule that any directory not starting with `_` will be copied as-is to the `_site` output. 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:
|
||||
|
||||
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…
Add table
Add a link
Reference in a new issue