master
Rafi59 2019-07-15 15:23:23 +02:00
commit 74861cc096
124 changed files with 3895 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
public/

20
.gitlab-ci.yml Normal file
View File

@ -0,0 +1,20 @@
# All available Hugo versions are listed here: https://gitlab.com/pages/hugo/container_registry
image: registry.gitlab.com/pages/hugo:latest
variables:
GIT_SUBMODULE_STRATEGY: recursive
test:
script:
- hugo
except:
- master
pages:
script:
- hugo
artifacts:
paths:
- public
only:
- master

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
The MIT License (MIT)
Copyright (c) 2014 Spencer Lyon
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.

81
README.md Normal file
View File

@ -0,0 +1,81 @@
![Build Status](https://gitlab.com/pages/hugo/badges/master/build.svg)
---
Example [Hugo] website using GitLab Pages.
Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation https://docs.gitlab.com/ce/user/project/pages/.
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [GitLab CI](#gitlab-ci)
- [Building locally](#building-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
- [Troubleshooting](#troubleshooting)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## GitLab CI
This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml).
## Building locally
To work locally with this project, you'll have to follow the steps below:
1. Fork, clone or download this project
1. [Install][] Hugo
1. Preview your project: `hugo server`
1. Add content
1. Generate the website: `hugo` (optional)
Read more at Hugo's [documentation][].
### Preview your site
If you clone or download this project to your local computer and run `hugo server`,
your site can be accessed under `localhost:1313/hugo/`.
The theme used is adapted from http://themes.gohugo.io/beautifulhugo/.
## GitLab User or Group Pages
To use this project as your user/group website, you will need one additional
step: just rename your project to `namespace.gitlab.io`, where `namespace` is
your `username` or `groupname`. This can be done by navigating to your
project's **Settings**.
You'll need to configure your site too: change this line
in your `config.toml`, from `"https://pages.gitlab.io/hugo/"` to `baseurl = "https://namespace.gitlab.io"`.
Proceed equally if you are using a [custom domain][post]: `baseurl = "http(s)://example.com"`.
Read more about [user/group Pages][userpages] and [project Pages][projpages].
## Did you fork this project?
If you forked this project for your own use, please go to your project's
**Settings** and remove the forking relationship, which won't be necessary
unless you want to contribute back to the upstream project.
## Troubleshooting
1. CSS is missing! That means two things:
Either that you have wrongly set up the CSS URL in your templates, or
your static generator has a configuration option that needs to be explicitly
set in order to serve static assets under a relative URL.
[ci]: https://about.gitlab.com/gitlab-ci/
[hugo]: https://gohugo.io
[install]: https://gohugo.io/overview/installing/
[documentation]: https://gohugo.io/overview/introduction/
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages
[post]: https://about.gitlab.com/2016/04/07/gitlab-pages-setup/#custom-domains

126
config.toml Normal file
View File

@ -0,0 +1,126 @@
baseurl = "https://axinite.codelib.re/"
contentdir = "content"
layoutdir = "layouts"
publishdir = "public"
title = "Minetest Axinite"
canonifyurls = true
copyright = "Axinite Website © 2019 to Axinite Team CC-BY-SA 3.0 for media and content."
DefaultContentLanguage = "fr"
theme = "hugo-bootstrap"
metaDataFormat = "yaml"
pygmentsUseClasses = true
pygmentCodeFences = true
#disqusShortname = "XXX"
#googleAnalytics = "XXX"
[Params]
subtitle = "Axinite website"
logo = "img/avatar-icon.png"
favicon = "img/favicon.ico"
dateFormat = "January 2, 2006"
commit = false
rss = true
comments = false
# gcse = "012345678901234567890:abcdefghijk" # Get your code from google.com/cse. Make sure to go to "Look and Feel" and change Layout to "Full Width" and Theme to "Classic"
[Params.sidebar]
# Whether to show the recent posts or not (default: true)
showRecent = false
# Whether to show the taxonomies or not (default: true)
showTaxonomy = true
# How many posts to show on the sidebar (Default: 5)
num_recent_posts = 0
[Params.header]
# Color scheme for the header (default: "light")
colorScheme = "dark"
[Author]
name = "Some Person"
email = "youremail@domain.com"
facebook = "username"
googleplus = "+username" # or xxxxxxxxxxxxxxxxxxxxx
gitlab = "username"
github = "username"
twitter = "username"
reddit = "username"
linkedin = "username"
xing = "username"
stackoverflow = "users/XXXXXXX/username"
snapchat = "username"
instagram = "username"
youtube = "user/username" # or channel/channelname
soundcloud = "username"
spotify = "username"
bandcamp = "username"
itchio = "username"
keybase = "username"
[languages]
[languages.fr]
languageName = "French"
[[languages.fr.menu.main]]
identifier = "accueil"
name = "Accueil"
url = ""
weight = "1"
[[languages.fr.menu.main]]
identifier = "gallerie"
name = "Galerie"
url = "page/images"
[[languages.fr.menu.main]]
identifier = "community"
name = "Forum"
url = "https://forum.axinite.codelib.re/"
[[languages.fr.menu.main]]
identifier = "carte"
name = "Carte"
url = "page/carte/"
[[languages.fr.menu.main]]
identifier = "wiki"
name = "Wiki"
url = "https://wiki.axinite.codelib.re/"
#[languages.en]
# languageName = "English"
#
# [[languages.en.menu.main]]
# identifier = "home"
# name = "Home"
# url = ""
# weight = "1"
#
# [[languages.en.menu.main]]
# identifier = "gallery"
# name = "Gallery"
# url = "en/gallery"
#
# [[languages.en.menu.main]]
# identifier = "community"
# name = "Forum"
# url = "https://forum.axinite.codelib.re/"
#
# [[languages.en.menu.main]]
# identifier = "map"
# name = "Map"
# url = "/en/map/"
#
# [[languages.en.menu.main]]
# identifier = "wiki"
# name = "Wiki"
# url = "https://axinite.codelib.re/doku.php?id=en:start/"

88
content/_index.md Normal file
View File

@ -0,0 +1,88 @@
---
title: Accueil
subtitle:
comments: false
---
<center><h2>Bienvenue sur Axinite !</h2>
<a class="btn btn-info" href="https://wiki.axinite.codelib.re/doku.php?id=se_connecter_au_serveur/" role="button">Se connecter</a> <a class="btn btn-warning" href="/page/regles" role="button">Les règles</a>
Le serveur est accessible à l'adresse axinite.rafi59.codelib.re sur le port 30000
</center>
<div id="carousel" class="carousel slide" data-ride="carousel">
<ol class="carousel-indicators">
<li data-target="#carousel" data-slide-to="0" class="active"></li>
<li data-target="#carousel" data-slide-to="1"></li>
<li data-target="#carousel" data-slide-to="2"></li>
</ol>
<div class="carousel-inner">
<div class="carousel-item active">
<img class="d-block w-100" src="img/spawn.jpg" alt="Bienvenue sur Axinite !">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="img/spawn_1.png" alt="">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="img/stade.png" alt="">
</div>
</div>
<a class="carousel-control-prev" href="#carousel" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#carousel" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
<center><h2>Serveurs</h2></center>
<center><p>L'adresse du serveur est axinite.rafi59.codelib.re</p></center>
<nav>
<div class="nav nav-tabs" id="nav-tab" role="tablist">
<a class="nav-item nav-link active" id="nav-survie-tab" data-toggle="tab" href="#nav-survie" role="tab" aria-controls="nav-survie" aria-selected="true">Serveur survie</a>
<a class="nav-item nav-link" id="nav-ctf-tab" data-toggle="tab" href="#nav-ctf" role="tab" aria-controls="nav-ctf" aria-selected="false">Serveur CTF</a>
</nav>
<div class="tab-content" id="nav-tabContent">
<div class="tab-pane fade show active" id="nav-survie" role="tabpanel" aria-labelledby="nav-survie-tab">Le serveur survie est le serveur classique disponible sur le port 30000.
![](/img/spawn_1.png)
</div>
<div class="tab-pane fade" id="nav-ctf" role="tabpanel" aria-labelledby="nav-profile-tab">Le serveur CTF (Capture the Flag) est disponible sur le port 30002.
![](/img/ctf.png)
</div>
<center><h2>Chat</h2></center>
<p>Le chat en jeu est connecté à IRC et Matrix.</p>
<table class="table table-borderless">
<thead>
<tr>
<th scope="col"></th>
<th scope="col"></th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">Discord</th>
<td><a class="btn btn-info" href="https://discord.gg/DXWZmJN" role="button">Rejoindre</a></td>
</tr>
<tr>
<th scope="row">Matrix</th>
<td><a class="btn btn-info" href="https://matrix.to/#/!aeUYvVcsBOyuUZFZOn:matrix.org?via=matrix.org" role="button">Rejoindre</a></td>
<td>![](/img/logo_matrix.png)</td>
</tr>
<tr>
<th scope="row">IRC</th>
<td colspan="2">#axinite sur freenode</td>
</tr>
</tbody>
</table>

91
content/en/_index.md Normal file
View File

@ -0,0 +1,91 @@
---
title: Home
subtitle:
comments: false
---
<center><h2>Welcome to Axinite !</h2>
<a class="btn btn-info" href="https://axinite.codelib.re/doku.php?id=en:se_connecter_au_serveur/" role="button">Login</a> <a class="btn btn-warning" href="/page/rules" role="button">The rules</a>
The server is available at axinite.rafi59.codelib.re on the port 30000
</center>
<div id="carousel" class="carousel slide" data-ride="carousel">
<ol class="carousel-indicators">
<li data-target="#carousel" data-slide-to="0" class="active"></li>
<li data-target="#carousel" data-slide-to="1"></li>
<li data-target="#carousel" data-slide-to="2"></li>
</ol>
<div class="carousel-inner">
<div class="carousel-item active">
<img class="d-block w-100" src="img/spawn.png" alt="">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="img/spawn_1.png" alt="">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="img/stade.png" alt="">
</div>
</div>
<a class="carousel-control-prev" href="#carousel" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#carousel" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>
<center><h2>Servers</h2></center>
<center><p>Server address is axinite.rafi59.codelib.re</p></center>
<nav>
<div class="nav nav-tabs" id="nav-tab" role="tablist">
<a class="nav-item nav-link active" id="nav-home-tab" data-toggle="tab" href="#nav-survival" role="tab" aria-controls="nav-survival" aria-selected="true">Survival server</a>
<a class="nav-item nav-link" id="nav-ctf-tab" data-toggle="tab" href="#nav-ctf" role="tab" aria-controls="nav-ctf" aria-selected="false">CTF server</a>
<a class="nav-item nav-link" id="nav-skyblock-tab" data-toggle="tab" href="#nav-skyblock" role="tab" aria-controls="nav-skyblock" aria-selected="false">Skyblock server</a>
</div>
</nav>
<div class="tab-content" id="nav-tabContent">
<div class="tab-pane fade show active" id="nav-survival" role="tabpanel" aria-labelledby="nav-survie-tab">Survival server is our primary server available on the port 30000.
![](/img/spawn_1.png)
</div>
<div class="tab-pane fade" id="nav-ctf" role="tabpanel" aria-labelledby="nav-ctf-tab">CTF (Capture the Flag) server is available on the port 30002.
![](/img/ctf.png)
</div>
<div class="tab-pane fade" id="nav-skyblock" role="tabpanel" aria-labelledby="nav-skyblock-tab">The Skyblock server is not public. To play it he has already built something on the survival server and ask the administrator for permission.</div>
</div>
<center><h2>Chat</h2></center>
<p>Ingame chat is connected to IRC and Matrix</p>
<table class="table table-borderless">
<thead>
<tr>
<th scope="col"></th>
<th scope="col"></th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">Discord</th>
<td><a class="btn btn-info" href="https://discord.gg/DXWZmJN" role="button">Join</a></td>
</tr>
<tr>
<th scope="row">Matrix</th>
<td><a class="btn btn-info" href="https://matrix.to/#/!aeUYvVcsBOyuUZFZOn:matrix.org?via=matrix.org" role="button">Join</a></td>
<td>![](/img/logo_matrix.png)</td>
</tr>
<tr>
<th scope="row">IRC</th>
<td colspan="2">#axinite on freenode</td>
</tr>
</tbody>
</table>

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

BIN
content/en/img/arbre.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 427 KiB

BIN
content/en/img/arene.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 358 KiB

BIN
content/en/img/ctf.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 661 KiB

View File

@ -0,0 +1,2 @@
[LocalizedFileNames]
logo_matrix.png=@logo_matrix.png,0

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 539 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 783 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 744 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 918 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
content/en/img/spawn.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 MiB

BIN
content/en/img/spawn_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 737 KiB

BIN
content/en/img/stade.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 726 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 593 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 629 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 696 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 575 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 114 KiB

BIN
content/img/arbre.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 427 KiB

BIN
content/img/arene.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.4 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
content/img/craftguide.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 358 KiB

BIN
content/img/ctf.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 661 KiB

2
content/img/desktop.ini Normal file
View File

@ -0,0 +1,2 @@
[LocalizedFileNames]
logo_matrix.png=@logo_matrix.png,0

Binary file not shown.

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

BIN
content/img/logo_matrix.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 539 KiB

BIN
content/img/param_gui.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

BIN
content/img/param_mouse.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 783 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 744 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 918 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

BIN
content/img/spawn.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 252 KiB

BIN
content/img/spawn_1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 737 KiB

BIN
content/img/stade.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 726 KiB

BIN
content/img/vieux_port.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 593 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 629 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.2 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 696 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 575 KiB

19
content/page/about.md Normal file
View File

@ -0,0 +1,19 @@
---
title: About me
subtitle: Why you'd want to hang out with me
comments: false
---
My name is The Dude. I have the following qualities:
- I rock a great beard
- I'm extremely loyal to my friends
- I like bowling
That rug really tied the room together.
### my history
To be honest, I'm having some trouble remembering right now, so why don't you
just watch [my movie](https://en.wikipedia.org/wiki/The_Big_Lebowski) and it
will answer **all** your questions.

32
content/page/accueil.md Normal file
View File

@ -0,0 +1,32 @@
---
title: Accueil
subtitle:
comments: false
---
<div id="carouselExampleIndicators" class="carousel slide" data-ride="carousel">
<ol class="carousel-indicators">
<li data-target="#carouselExampleIndicators" data-slide-to="0" class="active"></li>
<li data-target="#carouselExampleIndicators" data-slide-to="1"></li>
<li data-target="#carouselExampleIndicators" data-slide-to="2"></li>
</ol>
<div class="carousel-inner">
<div class="carousel-item active">
<img class="d-block w-100" src="..img/spawn.png" alt="First slide">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="..img/spawn.png" alt="Second slide">
</div>
<div class="carousel-item">
<img class="d-block w-100" src="..img/spawn.png" alt="Third slide">
</div>
</div>
<a class="carousel-control-prev" href="#carouselExampleIndicators" role="button" data-slide="prev">
<span class="carousel-control-prev-icon" aria-hidden="true"></span>
<span class="sr-only">Previous</span>
</a>
<a class="carousel-control-next" href="#carouselExampleIndicators" role="button" data-slide="next">
<span class="carousel-control-next-icon" aria-hidden="true"></span>
<span class="sr-only">Next</span>
</a>
</div>

7
content/page/carte.md Normal file
View File

@ -0,0 +1,7 @@
---
title: Realtime map
subtitle:
comments: false
---
<center><iframe width="1120" height="630" src="https://carte.axinite.codelib.re/#3/0.00/0.00" frameborder="0" allowfullscreen></iframe>

27
content/page/images.md Normal file
View File

@ -0,0 +1,27 @@
---
title: Images
subtitle:
comments: false
---
![](/img/vieux_port.png)
![](/img/build_battle.png)
![](/img/village_buildbattle1.png)
![](/img/village_buildbattle2.png)
![](/img/village_buildbattle3.png)
![](/img/village_buildbattle4.png)
![](/img/village_buildbattle5.png)
![](/img/village_buildbattle6.png)
![](/img/village_buildbattle7.png)
![](/img/pacific_house.png)
![](/img/arene.png)

29
content/page/regles.md Normal file
View File

@ -0,0 +1,29 @@
# Règles sur Axinite:
* **Les insultes, les menaces, le harcèlement et les discriminations seront sanctionnés.**
* **Toute forme de propagande ou prosélytisme à proscrire.**
* **Nendommagez pas les constructions des autres joueurs.**
* **La diffusion de vidéos de ce serveur requiert une autorisation de l'administrateur.**
* **Nendommagez pas le paysage, ni avec de l'eau ou de la lave.**
* **N'utilisez pas de lave, de sources axinitium ou de téléports pour tuer les joueurs.**
* **Soyez loyal, ne trichez pas, ne pillez pas, ne tuez pas les nouveaux.**
* **Faites un effort pour écrire correctement et pas tout en majuscules.**
* **Ne donnez, ni ne demandez dinformations personnelles.**
* **Le spam et le racolage pour d'autres serveurs seront sanctionnés.**
* **Ne demandez pas à devenir membre du staff.**
* **Votre compte est personnel, ne le prêtez pas. L'usurpation d'identité sera sanctionnée.**
* **S'il te plaît, merci, bonjour et au revoir font toujours plaisir à entendre et font parfois beaucoup :).**
* **Les arnaques avec les blocs du Build Battle sont interdites et seront très sévèrement sanctionnées.**

BIN
static/favicon.ico Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

View File

@ -0,0 +1,20 @@
The MIT License (MIT)
Copyright (c) 2015 Mihail Cristian Dumitru
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.

View File

@ -0,0 +1,34 @@
# Hugo Bootstrap v4 Theme
This is a simple Hugo theme using [Bootstrap v4](https://getbootstrap.com/), inspired by [hugo-theme-bootstrap4-blog](https://github.com/alanorth/hugo-theme-bootstrap4-blog).
## Demo
You can find a demo [here](https://themes.gohugo.io/theme/hugo-bootstrap/).
## Screenshots
![preview](https://raw.githubusercontent.com/Xzya/hugo-bootstrap/master/images/screenshot.png)
![preview](https://raw.githubusercontent.com/Xzya/hugo-bootstrap/master/images/screenshot2.png)
## Configuration
Check `exampleSite/config.toml` for an example configuration.
## Brand
The brand can be overriden by adding your own layout `layouts/partials/brand.html`. Check `exampleSite/layouts/partials/brand.html` for an example.
## Menu
The navbar displays the `main` menus by default. You can find more details about how to configure it [here](https://gohugo.io/templates/menu-templates/), as well as in the `exampleSite`.
## Multilanguage
The theme supports multiple languages.
You can find the default translation bundles in `i18n` (english and spanish by default).
## License
Open sourced under the [MIT license](./LICENSE.md).

View File

@ -0,0 +1,105 @@
baseurl = "https://example.com/"
title = "Bootstrap demo"
languageCode = "en-us"
defaultContentLanguage = "en"
# Pagination
paginate = 3
paginatePath = "page"
# Theme to use
theme = "hugo-bootstrap"
[taxonomies]
tag = "tags"
category = "categories"
# Google analytics
# googleAnalytics = ""
[languages.en]
languageName = "English"
# Replace the default footer message with a localized message
# copyright = "Hugo template made with ❤ by Xzya"
[[languages.en.menu.main]]
url = "/"
name = "Home"
weight = 1
[[languages.en.menu.main]]
url = "/about/"
name = "About"
weight = 2
[[languages.en.menu.main]]
url = "/contact/"
name = "Contact"
weight = 3
[languages.es]
languageName = "Español"
[[languages.es.menu.main]]
url = "/es/"
name = "Casa"
weight = 1
[[languages.es.menu.main]]
url = "/about/"
name = "Acerca de"
weight = 2
[[languages.es.menu.main]]
url = "/contact/"
name = "Contacto"
weight = 3
[languages.de]
languageName = "Deutsch"
[[languages.de.menu.main]]
url = "/de/"
name = "Start"
weight = 1
[[languages.de.menu.main]]
url = "/about/"
name = "Über uns"
weight = 2
[[languages.de.menu.main]]
url = "/contact/"
name = "Kontakt"
weight = 3
# Links format
[permalinks]
post = "/:year/:month/:title/"
[params]
# Main sections (currently used for the recent posts in the sidebar)
mainSections = ["post"]
# Default author
author = "John Doe"
# Date format (default: Jan 2, 2006)
# date_format = "Jan 2, 2006"
# Display post summaries instead of content in list templates (default: true)
# truncate = false
[params.sidebar]
# Whether to show the recent posts or not (default: true)
# showRecent = false
# Whether to show the taxonomies or not (default: true)
# showTaxonomy = false
# How many posts to show on the sidebar (Default: 5)
# num_recent_posts = 5
[params.header]
# Color scheme for the header (default: "light")
# colorScheme = "dark"
[params.footer]
# Color scheme for the footer (default: "light")
# colorScheme = "dark"

View File

@ -0,0 +1,13 @@
---
title: "Über uns"
---
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec ex vel orci dapibus aliquam non in metus. Vestibulum posuere justo nunc, eu eleifend orci dignissim in. Vestibulum eu eros neque. Quisque luctus posuere sapien nec accumsan. Maecenas mattis, nisl ac dictum ultrices, ligula eros vehicula eros, vel fermentum diam erat eget dolor. Suspendisse vitae felis ligula. Integer quis tincidunt risus, convallis ullamcorper dui. Suspendisse potenti. Sed scelerisque volutpat leo, at mattis ipsum posuere nec. Cras id velit imperdiet, laoreet lorem et, feugiat elit. Donec vitae odio fringilla, porttitor eros vel, varius magna.
Nulla molestie laoreet tortor, nec congue eros lacinia eget. Etiam aliquet odio semper felis ultrices, eget suscipit ex interdum. Proin maximus, dolor ac suscipit pretium, metus sapien pulvinar velit, posuere placerat libero urna nec dui. Praesent sed porttitor lacus. Suspendisse volutpat tempor gravida. Nam a dolor sed erat hendrerit porttitor. Sed semper eget sem et mollis. Integer ultrices luctus tellus, vitae semper augue tristique et. Phasellus sit amet ornare libero. Etiam risus tortor, suscipit non tempor vitae, sodales quis elit. Aliquam convallis nisl ac erat euismod scelerisque. Vivamus ornare lectus sit amet nisl facilisis maximus. Nulla interdum eu diam sit amet auctor. Nulla dapibus laoreet metus, et lacinia nulla facilisis ut. Duis volutpat nibh maximus ultrices sollicitudin. Curabitur orci justo, finibus ac ipsum eget, scelerisque pharetra elit.
In hac habitasse platea dictumst. Suspendisse facilisis justo posuere, luctus mi vel, elementum quam. Nullam imperdiet elit a erat gravida pretium. Cras pretium metus odio, tristique interdum urna varius a. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Praesent fringilla mauris id tincidunt varius. Aliquam erat volutpat. Suspendisse vitae euismod neque. Maecenas porta mauris a lectus suscipit, vehicula dictum odio condimentum. Ut at luctus enim, in pretium urna.
Phasellus sagittis at mauris vitae mattis. Proin sed tortor fringilla, porta risus sed, faucibus odio. Maecenas fermentum vitae metus sit amet rutrum. Fusce porttitor elit vitae nisi sollicitudin luctus. Nunc purus urna, porttitor quis neque ac, viverra volutpat arcu. Sed pulvinar pellentesque placerat. Praesent iaculis, nisl non efficitur fermentum, lacus ligula porta tortor, feugiat dapibus diam justo a sapien. Sed neque odio, fermentum eu convallis non, consequat sollicitudin sem. Nullam placerat augue sed tortor ultricies vulputate. Nunc cursus elit at consectetur accumsan. Suspendisse potenti. Cras ultrices interdum dui vitae consequat. Maecenas porta mauris urna, in fermentum nisi pharetra eu.
Donec a ex sit amet mauris accumsan sagittis vel eget turpis. In leo lorem, dignissim vitae justo sit amet, congue porttitor nisi. Nunc commodo mattis dapibus. Proin condimentum sagittis euismod. Quisque consectetur velit sed volutpat dignissim. Proin ac enim metus. Quisque eu arcu sapien. In hac habitasse platea dictumst. Etiam scelerisque urna risus, a sagittis diam ornare sed.

View File

@ -0,0 +1,13 @@
---
title: "Acerca de"
---
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec ex vel orci dapibus aliquam non in metus. Vestibulum posuere justo nunc, eu eleifend orci dignissim in. Vestibulum eu eros neque. Quisque luctus posuere sapien nec accumsan. Maecenas mattis, nisl ac dictum ultrices, ligula eros vehicula eros, vel fermentum diam erat eget dolor. Suspendisse vitae felis ligula. Integer quis tincidunt risus, convallis ullamcorper dui. Suspendisse potenti. Sed scelerisque volutpat leo, at mattis ipsum posuere nec. Cras id velit imperdiet, laoreet lorem et, feugiat elit. Donec vitae odio fringilla, porttitor eros vel, varius magna.
Nulla molestie laoreet tortor, nec congue eros lacinia eget. Etiam aliquet odio semper felis ultrices, eget suscipit ex interdum. Proin maximus, dolor ac suscipit pretium, metus sapien pulvinar velit, posuere placerat libero urna nec dui. Praesent sed porttitor lacus. Suspendisse volutpat tempor gravida. Nam a dolor sed erat hendrerit porttitor. Sed semper eget sem et mollis. Integer ultrices luctus tellus, vitae semper augue tristique et. Phasellus sit amet ornare libero. Etiam risus tortor, suscipit non tempor vitae, sodales quis elit. Aliquam convallis nisl ac erat euismod scelerisque. Vivamus ornare lectus sit amet nisl facilisis maximus. Nulla interdum eu diam sit amet auctor. Nulla dapibus laoreet metus, et lacinia nulla facilisis ut. Duis volutpat nibh maximus ultrices sollicitudin. Curabitur orci justo, finibus ac ipsum eget, scelerisque pharetra elit.
In hac habitasse platea dictumst. Suspendisse facilisis justo posuere, luctus mi vel, elementum quam. Nullam imperdiet elit a erat gravida pretium. Cras pretium metus odio, tristique interdum urna varius a. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Praesent fringilla mauris id tincidunt varius. Aliquam erat volutpat. Suspendisse vitae euismod neque. Maecenas porta mauris a lectus suscipit, vehicula dictum odio condimentum. Ut at luctus enim, in pretium urna.
Phasellus sagittis at mauris vitae mattis. Proin sed tortor fringilla, porta risus sed, faucibus odio. Maecenas fermentum vitae metus sit amet rutrum. Fusce porttitor elit vitae nisi sollicitudin luctus. Nunc purus urna, porttitor quis neque ac, viverra volutpat arcu. Sed pulvinar pellentesque placerat. Praesent iaculis, nisl non efficitur fermentum, lacus ligula porta tortor, feugiat dapibus diam justo a sapien. Sed neque odio, fermentum eu convallis non, consequat sollicitudin sem. Nullam placerat augue sed tortor ultricies vulputate. Nunc cursus elit at consectetur accumsan. Suspendisse potenti. Cras ultrices interdum dui vitae consequat. Maecenas porta mauris urna, in fermentum nisi pharetra eu.
Donec a ex sit amet mauris accumsan sagittis vel eget turpis. In leo lorem, dignissim vitae justo sit amet, congue porttitor nisi. Nunc commodo mattis dapibus. Proin condimentum sagittis euismod. Quisque consectetur velit sed volutpat dignissim. Proin ac enim metus. Quisque eu arcu sapien. In hac habitasse platea dictumst. Etiam scelerisque urna risus, a sagittis diam ornare sed.

View File

@ -0,0 +1,13 @@
---
title: "About"
---
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed nec ex vel orci dapibus aliquam non in metus. Vestibulum posuere justo nunc, eu eleifend orci dignissim in. Vestibulum eu eros neque. Quisque luctus posuere sapien nec accumsan. Maecenas mattis, nisl ac dictum ultrices, ligula eros vehicula eros, vel fermentum diam erat eget dolor. Suspendisse vitae felis ligula. Integer quis tincidunt risus, convallis ullamcorper dui. Suspendisse potenti. Sed scelerisque volutpat leo, at mattis ipsum posuere nec. Cras id velit imperdiet, laoreet lorem et, feugiat elit. Donec vitae odio fringilla, porttitor eros vel, varius magna.
Nulla molestie laoreet tortor, nec congue eros lacinia eget. Etiam aliquet odio semper felis ultrices, eget suscipit ex interdum. Proin maximus, dolor ac suscipit pretium, metus sapien pulvinar velit, posuere placerat libero urna nec dui. Praesent sed porttitor lacus. Suspendisse volutpat tempor gravida. Nam a dolor sed erat hendrerit porttitor. Sed semper eget sem et mollis. Integer ultrices luctus tellus, vitae semper augue tristique et. Phasellus sit amet ornare libero. Etiam risus tortor, suscipit non tempor vitae, sodales quis elit. Aliquam convallis nisl ac erat euismod scelerisque. Vivamus ornare lectus sit amet nisl facilisis maximus. Nulla interdum eu diam sit amet auctor. Nulla dapibus laoreet metus, et lacinia nulla facilisis ut. Duis volutpat nibh maximus ultrices sollicitudin. Curabitur orci justo, finibus ac ipsum eget, scelerisque pharetra elit.
In hac habitasse platea dictumst. Suspendisse facilisis justo posuere, luctus mi vel, elementum quam. Nullam imperdiet elit a erat gravida pretium. Cras pretium metus odio, tristique interdum urna varius a. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Praesent fringilla mauris id tincidunt varius. Aliquam erat volutpat. Suspendisse vitae euismod neque. Maecenas porta mauris a lectus suscipit, vehicula dictum odio condimentum. Ut at luctus enim, in pretium urna.
Phasellus sagittis at mauris vitae mattis. Proin sed tortor fringilla, porta risus sed, faucibus odio. Maecenas fermentum vitae metus sit amet rutrum. Fusce porttitor elit vitae nisi sollicitudin luctus. Nunc purus urna, porttitor quis neque ac, viverra volutpat arcu. Sed pulvinar pellentesque placerat. Praesent iaculis, nisl non efficitur fermentum, lacus ligula porta tortor, feugiat dapibus diam justo a sapien. Sed neque odio, fermentum eu convallis non, consequat sollicitudin sem. Nullam placerat augue sed tortor ultricies vulputate. Nunc cursus elit at consectetur accumsan. Suspendisse potenti. Cras ultrices interdum dui vitae consequat. Maecenas porta mauris urna, in fermentum nisi pharetra eu.
Donec a ex sit amet mauris accumsan sagittis vel eget turpis. In leo lorem, dignissim vitae justo sit amet, congue porttitor nisi. Nunc commodo mattis dapibus. Proin condimentum sagittis euismod. Quisque consectetur velit sed volutpat dignissim. Proin ac enim metus. Quisque eu arcu sapien. In hac habitasse platea dictumst. Etiam scelerisque urna risus, a sagittis diam ornare sed.

View File

@ -0,0 +1,5 @@
---
title: "Kontakt"
---
Kontaktieren Sie uns!

View File

@ -0,0 +1,5 @@
---
title: "Contacto"
---
Contact us!

View File

@ -0,0 +1,5 @@
---
title: "Contact"
---
Contact us!

View File

@ -0,0 +1,13 @@
---
title: Primer comentario!
date: 2015-01-05
tags: ["demo"]
---
This is my first post, how exciting!
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
<!--more-->
Nullam at magna blandit, bibendum massa non, tincidunt turpis. Phasellus convallis lorem quis leo vulputate posuere. Nullam sit amet mattis lorem. Praesent et dolor feugiat, fringilla mauris iaculis, fringilla purus. Duis a finibus justo. Praesent tincidunt malesuada quam, ornare euismod sem vulputate vitae. Suspendisse consectetur ut felis vel tempor. Ut a viverra quam, quis luctus lorem. Pellentesque dolor ipsum, euismod vitae felis sit amet, fermentum consequat mi. Pellentesque eget mauris eu mi suscipit consequat.

View File

@ -0,0 +1,13 @@
---
title: First post!
date: 2015-01-05
tags: ["demo"]
---
This is my first post, how exciting!
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
<!--more-->
Nullam at magna blandit, bibendum massa non, tincidunt turpis. Phasellus convallis lorem quis leo vulputate posuere. Nullam sit amet mattis lorem. Praesent et dolor feugiat, fringilla mauris iaculis, fringilla purus. Duis a finibus justo. Praesent tincidunt malesuada quam, ornare euismod sem vulputate vitae. Suspendisse consectetur ut felis vel tempor. Ut a viverra quam, quis luctus lorem. Pellentesque dolor ipsum, euismod vitae felis sit amet, fermentum consequat mi. Pellentesque eget mauris eu mi suscipit consequat.

View File

@ -0,0 +1,13 @@
---
title: Erster Artikel!
date: 2015-01-05
tags: ["demo"]
---
Das ist mein erster Artikel, wie spannend!
Lorem ipsum dolor sit amet, consectetur adipiscing elit.
<!--more-->
Nullam at magna blandit, bibendum massa non, tincidunt turpis. Phasellus convallis lorem quis leo vulputate posuere. Nullam sit amet mattis lorem. Praesent et dolor feugiat, fringilla mauris iaculis, fringilla purus. Duis a finibus justo. Praesent tincidunt malesuada quam, ornare euismod sem vulputate vitae. Suspendisse consectetur ut felis vel tempor. Ut a viverra quam, quis luctus lorem. Pellentesque dolor ipsum, euismod vitae felis sit amet, fermentum consequat mi. Pellentesque eget mauris eu mi suscipit consequat.

View File

@ -0,0 +1,4 @@
---
title: Posts
---
Hello world!

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,344 @@
+++
title = "(Hu)go Template Primer"
description = ""
tags = [
"go",
"golang",
"templates",
"themes",
"development",
"demo",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
+++
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
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 &#xA9; 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/>

View File

@ -0,0 +1,344 @@
+++
title = "(Hu)go Template Primer"
description = ""
tags = [
"go",
"golang",
"templates",
"themes",
"development",
"demo",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
+++
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
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 &#xA9; 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/>

View File

@ -0,0 +1,344 @@
+++
title = "(Hu)go Template Primer"
description = ""
tags = [
"go",
"golang",
"templates",
"themes",
"development",
"demo",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
+++
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
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 &#xA9; 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/>

View File

@ -0,0 +1,90 @@
+++
title = "Getting Started with Hugo"
description = ""
tags = [
"go",
"golang",
"hugo",
"development",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
author = "John Doe"
language = "es"
+++
## Step 1. Install Hugo
Goto [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 [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.

View File

@ -0,0 +1,90 @@
+++
title = "Getting Started with Hugo"
description = ""
tags = [
"go",
"golang",
"hugo",
"development",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
author = "John Doe"
language = "es"
+++
## Step 1. Install Hugo
Goto [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 [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.

View File

@ -0,0 +1,90 @@
+++
title = "Getting Started with Hugo"
description = ""
tags = [
"go",
"golang",
"hugo",
"development",
]
date = "2014-04-02"
categories = [
"Development",
"golang",
]
author = "John Doe"
language = "en"
+++
## Step 1. Install Hugo
Goto [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 [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.

View File

@ -0,0 +1,153 @@
---
date: 2014-03-10
linktitle: Migrating from Jekyll
prev: /tutorials/mathjax
title: Migrate to Hugo from Jekyll
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. 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).

View File

@ -0,0 +1,3 @@
<img src="https://getbootstrap.com/docs/4.1/assets/brand/bootstrap-solid.svg" width="30" height="30" class="d-inline-block align-top"
alt="">
{{ .Site.Title }}

View File

@ -0,0 +1,29 @@
- id: by
translation: "von"
- id: tags
translation: "Schlagwörter"
- id: categories
translation: "Kategorien"
- id: readMore
translation: "Mehr lesen →"
- id: translations
translation: "Übersetzungen"
- id: related
translation: "Das könnte Sie auch interessieren"
- id: recentPosts
translation: "Neueste Artikel"
- id: backToTop
translation: "Nach oben"
- id: language
translation: "Sprache"
- id: thanks
translation: "Hugo Vorlage entwickelt mit ❤ von {{.Xzya}}, inspiriert von {{.HugoThemeBootstrap4Blog}}"

View File

@ -0,0 +1,29 @@
- id: by
translation: "by"
- id: tags
translation: "Tags"
- id: categories
translation: "Categories"
- id: readMore
translation: "Read More →"
- id: translations
translation: "Translations"
- id: related
translation: "See also"
- id: recentPosts
translation: "Recent Posts"
- id: backToTop
translation: "Back to top"
- id: language
translation: "Language"
- id: thanks
translation: "Hugo template made with ❤ by {{.Xzya}}, inspired by {{.HugoThemeBootstrap4Blog}}"

View File

@ -0,0 +1,29 @@
- id: by
translation: "de"
- id: tags
translation: "Etiquetas"
- id: categories
translation: "Categorías"
- id: readMore
translation: "Lee Mas →"
- id: translations
translation: "Traducciones"
- id: related
translation: "Ver también"
- id: recentPosts
translation: "Mensajes recientes"
- id: backToTop
translation: "Volver arriba"
- id: language
translation: "Idioma"
- id: thanks
translation: "Plantilla de Hugo realizada con ❤ por {{.Xzya}}, inspirada en {{.HugoThemeBootstrap4Blog}}"

View File

@ -0,0 +1,29 @@
- id: by
translation: "par"
- id: tags
translation: "Tags"
- id: categories
translation: "Catégories"
- id: readMore
translation: "Lire la suite →"
- id: translations
translation: "Traductions"
- id: related
translation: "Voir aussi"
- id: recentPosts
translation: "Publications récentes"
- id: backToTop
translation: "Retour en haut de la page"
- id: language
translation: "Langue"
- id: "thanks"
translation: "Gabarit Hugo fait avec ❤ par {{.Xzya}}, inspiré par {{.HugoThemeBootstrap4Blog}}"

View File

@ -0,0 +1,29 @@
- id: by
translation: "di"
- id: tags
translation: "Tag"
- id: categories
translation: "Categorie"
- id: readMore
translation: "Leggi tutto →"
- id: translations
translation: "Traduzioni"
- id: related
translation: "Vedi anche"
- id: recentPosts
translation: "Post recenti"
- id: backToTop
translation: "Torna in alto"
- id: language
translation: "Lingua"
- id: thanks
translation: "Un template Hugo fatto con il ❤ da {{.Xzya}}, ispirato da {{.HugoThemeBootstrap4Blog}}"

Some files were not shown because too many files have changed in this diff Show More