Merge branch 'main' of ssh://git.n07070.xyz:1968/n07070/blogotheme
This commit is contained in:
commit
0ca1bd9157
@ -162,7 +162,7 @@ p {
|
||||
/* padding: 2em 0; */
|
||||
margin-bottom: 3rem;
|
||||
margin-top: 1em;
|
||||
width: 100%;
|
||||
/* width: 100%; */
|
||||
max-width: 50rem;
|
||||
/* border-radius: 1.2rem; */
|
||||
z-index: 2;
|
||||
@ -298,20 +298,22 @@ p {
|
||||
}
|
||||
.pagination-nav {
|
||||
margin: 2em 0;
|
||||
width: 100%;
|
||||
max-width: 47rem;
|
||||
}
|
||||
|
||||
.pagination-text {
|
||||
font-weight: bold;
|
||||
color: inherit;
|
||||
padding: 1rem;
|
||||
text-align: center;
|
||||
align-content: center;
|
||||
}
|
||||
|
||||
.pagination-newer {
|
||||
float:left;
|
||||
float:right;
|
||||
}
|
||||
.pagination-older {
|
||||
float: right;
|
||||
float: left;
|
||||
}
|
||||
.button {
|
||||
padding: 0.5em 0.6em;
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 29 KiB |
@ -1,16 +0,0 @@
|
||||
baseurl = "https://example.com"
|
||||
title = "Hugo Themes - aether"
|
||||
author = "Joe Hutchinson"
|
||||
canonifyurls = true
|
||||
paginate = 3
|
||||
theme = "aether"
|
||||
themesDir = "../../"
|
||||
|
||||
[params]
|
||||
brand = "aether"
|
||||
description = "aether Hugo theme for blogs"
|
||||
headshotimg = "img/faceshot.jpg"
|
||||
|
||||
[markup]
|
||||
[markup.highlight]
|
||||
style = "igor"
|
||||
@ -1,5 +0,0 @@
|
||||
---
|
||||
title: "aether"
|
||||
date: 2018-04-27T09:46:15-04:00
|
||||
description: "A clean Hugo theme for blogs emphasizing motion, material, and depth."
|
||||
---
|
||||
@ -1,20 +0,0 @@
|
||||
+++
|
||||
title = "About Hugo"
|
||||
date = "2014-04-09"
|
||||
displayInMenu = true
|
||||
displayInList = false
|
||||
dropCap = false
|
||||
+++
|
||||
|
||||
Hugo is the **world’s fastest framework for building websites**. It is written in Go.
|
||||
|
||||
It makes use of a variety of open source projects including:
|
||||
|
||||
* https://github.com/russross/blackfriday
|
||||
* https://github.com/alecthomas/chroma
|
||||
* https://github.com/muesli/smartcrop
|
||||
* https://github.com/spf13/cobra
|
||||
* https://github.com/spf13/viper
|
||||
|
||||
Learn more and contribute on [GitHub](https://github.com/gohugoio).
|
||||
|
||||
@ -1,135 +0,0 @@
|
||||
---
|
||||
title: "Aether Features"
|
||||
date: 2018-12-19T10:35:35-05:00
|
||||
description: "Hugo combined with the Aether theme turns easy to write markdown into powerful web pages. KaTeX, Highlight.js, and Hugo provides the ability to create mathmatical symobols, equations, highlighted code, tables, lists, and much more."
|
||||
categories: ["Features"]
|
||||
dropCap: true
|
||||
displayInMenu: false
|
||||
displayInList: true
|
||||
draft: false
|
||||
resources:
|
||||
- name: featuredImage
|
||||
src: "mdd-iphone.jpg"
|
||||
---
|
||||
|
||||
Hugo combined with the Aether theme turns easy to write markdown into powerful web pages. KaTeX, Highlight.js, and Hugo provides the ability to create mathmatical symobols, equations, highlighted code, tables, lists, and much more.
|
||||
|
||||
For each feature below, the first line is the markdown and the second line is the result after Hugo, KaTeX, and Highlight.js process the markdown. You can find many more features in the Hugo documentation.
|
||||
|
||||
## LaTeX style math typsetting with KaTeX
|
||||
|
||||
```md
|
||||
{{</* raw */>}}
|
||||
\[u(t) = K_p e(t) + K_i \int_{0}^{t} e(\tau) d\tau + K_d \frac{de(t)}{dt} \]
|
||||
{{</* /raw */>}}
|
||||
```
|
||||
|
||||
{{< raw >}}
|
||||
\[u(t) = K_p e(t) + K_i \int_{0}^{t} e(\tau) d\tau + K_d \frac{de(t)}{dt} \]
|
||||
{{< /raw >}}
|
||||
|
||||
## Code (Supports many programming languages and formats)
|
||||
|
||||
````md
|
||||
```javascript
|
||||
var s = "JavaScript syntax highlighting";
|
||||
alert(s);
|
||||
```
|
||||
````
|
||||
|
||||
```javascript
|
||||
var s = "JavaScript syntax highlighting";
|
||||
alert(s);
|
||||
```
|
||||
|
||||
## Inline code
|
||||
|
||||
```md
|
||||
Here is `var s = "Hello World"` inline code
|
||||
```
|
||||
|
||||
Here is `var s = "Hello World"` inline code
|
||||
|
||||
## Tables
|
||||
|
||||
```md
|
||||
| Tables | Are | Cool |
|
||||
| ------------- |:-------------:| -----:|
|
||||
| col 3 is | right-aligned | $1600 |
|
||||
| col 2 is | centered | $12 |
|
||||
| zebra stripes | are neat | $1 |
|
||||
```
|
||||
|
||||
| Tables | Are | Cool |
|
||||
| ------------- |:-------------:| -----:|
|
||||
| col 3 is | right-aligned | $1600 |
|
||||
| col 2 is | centered | $12 |
|
||||
| zebra stripes | are neat | $1 |
|
||||
|
||||
## Ordered List
|
||||
|
||||
```md
|
||||
1. Number one
|
||||
2. Number Two
|
||||
1. Indented Number 1
|
||||
2. Indented Number 2
|
||||
```
|
||||
|
||||
1. Number one
|
||||
2. Number Two
|
||||
1. Indented Number 1
|
||||
2. Indented Number 2
|
||||
|
||||
## Unordered List
|
||||
|
||||
```md
|
||||
* Get groceries at Harris Teeter before the party
|
||||
* Get a Spider Man cake
|
||||
* Chocolate or marble
|
||||
* Whipped cream frosting
|
||||
* Don't forget to walk the dog before you leave
|
||||
* Bring lots of plates and silverware so that we don't run out
|
||||
* Plastic Dixie brand is fine
|
||||
```
|
||||
|
||||
* Get groceries at Harris Teeter before the party
|
||||
* Get a Spider Man cake
|
||||
* Chocolate or marble
|
||||
* Whipped cream frosting
|
||||
* Don't forget to walk the dog before you leave
|
||||
* Bring lots of plates and silverware so that we don't run out
|
||||
* Plastic Dixie brand is fine
|
||||
|
||||
## Comments
|
||||
|
||||
```md
|
||||
> This is some text that should show up as a comment. Someone may have made this comment but i'm not sure.
|
||||
```
|
||||
|
||||
> This is some text that should show up as a comment. Someone may have made this comment but i'm not sure.
|
||||
|
||||
## Images
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Small Images
|
||||
|
||||
```md
|
||||
{{</* smallimg src="featuredImage" alt="NYC Skyline" smartfloat="left" width="250px" */>}}
|
||||
```
|
||||
|
||||
{{<smallimg src="featuredImage" alt="aether theme displayed on an iPhone" smartfloat="left" width="250px">}}
|
||||
|
||||
This image floats to the left of this paragraph and is 250px wide. Its aspect ratio is maintained so it will not stretch. The picture shows the New York skyline. You can see how the design is responsive and how the cards intelligently fit to the display. With flexbox and css grid, heavy frameworks such as bootstrap aren't necessary to create beautiful responsive designs. The cards in aether use flexbox to change the image from the right side on desktops to the top on mobile.
|
||||
|
||||
## Links
|
||||
|
||||
```md
|
||||
[Aether's Github page](https://github.com/josephhutch/aether)
|
||||
```
|
||||
|
||||
[Aether's Github page](https://github.com/josephhutch/aether)
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 778 KiB |
@ -1,97 +0,0 @@
|
||||
---
|
||||
title: "Aether: A Clean Theme for Hugo"
|
||||
date: 2018-05-02T14:33:42-04:00
|
||||
description: " Aether is new theme for Hugo that emphasizes motion, material, and depth as design elements. Distracting styling and page elements are forgone to focus on the content."
|
||||
categories: ["Web"]
|
||||
dropCap: true
|
||||
displayInMenu: false
|
||||
displayInList: true
|
||||
draft: false
|
||||
resources:
|
||||
- name: featuredImage
|
||||
src: "mdd-macbook.jpg"
|
||||
params:
|
||||
description: "A MacBook showing a website using the aether theme"
|
||||
---
|
||||
|
||||
Today's web is a frustrating mess of pop-ups, intrusive banners, and ads obstructing the content. I designed aether to be free of all these distractions and simply highlight the content. The result feels more like a native application than a website. Interactions are intuitive, content is the focus, and distractions are omitted.
|
||||
|
||||
Aether is a Hugo theme for blogs that elevates good writing and photography. If you use Hugo for your blog, give aether a try.
|
||||
|
||||
## Installation
|
||||
In the root directory of your Hugo Project, clone the aether repo into the themes directory.
|
||||
|
||||
```shell session
|
||||
git clone https://github.com/josephhutch/aether.git themes/aether
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
### Website Configuration
|
||||
|
||||
Add the following parameters to your config file if they are not present already.
|
||||
|
||||
```toml
|
||||
baseURL = "https://yourwebsitenamegoeshere.com"
|
||||
languageCode = "your language code"
|
||||
title = "your website title"
|
||||
theme = "aether"
|
||||
googleAnalytics = "Your google analytics tracking ID"
|
||||
|
||||
[params]
|
||||
brand = "the title displayed in the nav bar - optional"
|
||||
description = "your website's description"
|
||||
homeimg = "url to the image used for the home button - optional"
|
||||
bgimg = "url to the image used for the background - optional"
|
||||
```
|
||||
|
||||
The `title` parameter is used for each page title, the title that search engines display in search results. If you would like the title shown in the top left of the page to be different from the page title, use the `brand` parameter. For instance, the title parameter for my site is `Joe Hutchinson` but the brand parameter is set to `joehutch`.
|
||||
|
||||
The `homeimg` and `bgimg` parameters give you the ability to customize the look of your site further. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Similarly, the bgimg parameter is used for the background of each webpage. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color.
|
||||
|
||||
That is the only configuration required at the site level! You can now begin writing content for your site.
|
||||
|
||||
### Creating content
|
||||
Make a new blog post by executing `hugo new posts/postnamehere/index.md` in your shell. At the top of the new markdown file, is what's called the front matter. The front matter is the page's metadata that determines how Hugo and aether generate the HTML for your post. Below you can find what the front matter should contain for a new post and what each of the parameters mean.
|
||||
|
||||
```properties
|
||||
---
|
||||
title: "The title of your post"
|
||||
date: date the post was generated
|
||||
description: "Description of the post (displayed in the post's card)"
|
||||
categories: ["add comma separated categories here", "another category"]
|
||||
featuredImage: "url to the page's featured image"
|
||||
featuredImageDescription: "Description for the featured image, used as the alt text"
|
||||
dropCap: if the first letter should be a large decorative capital letter (true, false)
|
||||
displayInMenu: if post is listed in the navigation menu (true, false)
|
||||
displayInList: if post is listed on the home page and category pages (true, false)
|
||||
draft: if the page is a draft (true, false)
|
||||
---
|
||||
```
|
||||
|
||||
The `displayInMenu` and `displayInList` parameters are used to determine where your content is displayed. Posts typically have displayInMenu set to false so that the post is not a menu option, and displayInList set to true so it shows up on the homepage's list of posts and in category page lists. An About Me page, on the other hand, would have displayInMenu set to true and displayInList set to false. That will allow the About Me page to be accessible from the menu but not displayed in the homepage's list of posts.
|
||||
|
||||
The `categories` parameter is used to group similar posts in category pages. Category pages are accessible from the menu and list all posts with the same category.
|
||||
|
||||
The `dropCap` parameter is used to determine if the first letter of a post should be a dropped capital. A dropped capital letter is the large decorative letter at the beginning of a book or section.
|
||||
|
||||
Add an interesting description and a good image to each post to get the most value from this theme.
|
||||
|
||||
Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site. This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/). Use the `image` and `smallimg` shortcodes to take full advantage of image optimization.
|
||||
|
||||
Posts are written in markdown and LaTeX (for math symbols and equations). You can find tons of information on how to format your posts with markdown and LaTeX on the web.
|
||||
|
||||
### Further Customization
|
||||
To change the heading and subtext at the top of list pages just add a \_index.md file in the folder that the list page is generated from. For example to change the heading at the top of the homepage, add an \_index.md file to the content folder with the following parameters.
|
||||
|
||||
```properties
|
||||
---
|
||||
title: "This is the main heading text in big letters"
|
||||
date: the date
|
||||
description: "This is the subtext above the main heading in small letters"
|
||||
---
|
||||
```
|
||||
|
||||
### Learn More
|
||||
|
||||
To learn more about aether, visit [aether's Github page](https://github.com/josephhutch/aether). To learn more about Hugo, visit [Hugo's website](https://gohugo.io/).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 551 KiB |
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 261 KiB |
@ -1,350 +0,0 @@
|
||||
+++
|
||||
title = "(Hu)go Template Primer"
|
||||
displayInMenu = false
|
||||
displayInList = true
|
||||
draft = false
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"templates",
|
||||
"themes",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
[[resources]]
|
||||
name = "featuredImage"
|
||||
src = "lucas-benjamin-565254-unsplash.jpg"
|
||||
[resources.params]
|
||||
description = "Alt description for the featured image"
|
||||
+++
|
||||
|
||||
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/
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 132 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 95 KiB |
@ -1,94 +0,0 @@
|
||||
+++
|
||||
title = "Getting Started with Hugo"
|
||||
featuredImage = "img/andrew-neel-609846-unsplash.jpg"
|
||||
displayInMenu = false
|
||||
displayInList = true
|
||||
draft = false
|
||||
tags = [
|
||||
"go",
|
||||
"golang",
|
||||
"hugo",
|
||||
"development",
|
||||
]
|
||||
date = "2014-04-02"
|
||||
categories = [
|
||||
"Development",
|
||||
"golang",
|
||||
]
|
||||
[[resources]]
|
||||
name = "featuredImage"
|
||||
src = "andrew-neel-609846-unsplash.jpg"
|
||||
+++
|
||||
|
||||
## 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.
|
||||
@ -1,156 +0,0 @@
|
||||
---
|
||||
date: 2014-03-10
|
||||
displayInMenu: false
|
||||
displayInList: true
|
||||
draft: false
|
||||
title: Migrate to Hugo from Jekyll
|
||||
resources:
|
||||
- name: featuredImage
|
||||
src: "yan-ots-257617-unsplash.jpg"
|
||||
---
|
||||
|
||||
## 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).
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 126 KiB |
@ -1,13 +0,0 @@
|
||||
<meta property="og:locale" content="{{ .Site.Language.Lang }}">
|
||||
<meta property="og:type" content="{{ if .IsHome }}website{{ else }}article{{ end }}">
|
||||
<meta property="og:title" content="{{ .Site.Params.Brand }}">
|
||||
<meta property="og:description" content="{{ .Site.Params.description }}">
|
||||
<meta property="og:url" content="{{ .Permalink }}">
|
||||
<meta property="og:site_name" content="{{ .Site.Params.Brand }}">
|
||||
<meta property="og:image" content="{{ .Site.Params.metaImage | absURL }}">
|
||||
<meta name="twitter:card" content="summary">
|
||||
<meta name="twitter:title" content="{{ .Site.Params.Brand }}">
|
||||
<meta name="twitter:description" content="{{ .Site.Params.description }}">
|
||||
<meta name="twitter:site" content="{{ .Site.BaseURL }}">
|
||||
<meta name="twitter:creator" content="{{ .Site.Params.metaCreator }}">
|
||||
<meta name="twitter:image" content="{{ .Site.Params.metaImage | absURL }}">
|
||||
0
exampleSite/static/.gitignore
vendored
0
exampleSite/static/.gitignore
vendored
@ -5,8 +5,9 @@
|
||||
|
||||
<body class="list-body">
|
||||
|
||||
{{ partial "nav-bar.html" . }}
|
||||
|
||||
<main class="card-container side-gutter">
|
||||
{{ partial "nav-bar.html" . }}
|
||||
|
||||
{{ if or (not (eq .Description "")) (not (eq .Title "")) -}}
|
||||
{{- end }}
|
||||
@ -23,13 +24,15 @@
|
||||
{{- range $paginator.Pages -}}
|
||||
{{ .Render "li" }}
|
||||
{{- end }}
|
||||
</main>
|
||||
|
||||
{{ if or ($paginator.HasPrev) ($paginator.HasNext) -}}
|
||||
<nav class="pagination-nav side-padding">
|
||||
<nav class="blog-card blog-card-feed">
|
||||
{{ if $paginator.HasPrev }}<a href="{{ $paginator.Prev.URL }}" class="pagination-newer pagination-text">< Newer Posts</a>{{ end }}
|
||||
{{ if $paginator.HasNext }}<a href="{{ $paginator.Next.URL }}" class="pagination-older pagination-text">Older Posts ></a>{{ end }}
|
||||
</nav>
|
||||
{{- end }}
|
||||
</main>
|
||||
|
||||
{{ partial "scripts.html" . }}
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
|
||||
|
||||
<channel>
|
||||
<title>{{ if eq .Title .Site.Title }}{{ .Site.Title }}{{ else }}{{ with .Title }}{{.}} - {{ end }}{{ .Site.Title }}{{ end }}</title>
|
||||
<link>{{ .Permalink }}</link>
|
||||
@ -30,18 +31,21 @@
|
||||
{{ printf "<atom:link href=%q rel=\"self\" type=%q />" .Permalink .MediaType | safeHTML }}
|
||||
{{ end }}
|
||||
|
||||
{{ $paginator := .Paginate (where .Pages "Params.displayinlist" "!=" false) -}}
|
||||
{{ $pages := .Site.RegularPages }}
|
||||
{{ $paginator := .Paginate (where $pages "Params.displayinlist" "!=" false) -}}
|
||||
{{- range $paginator.Pages -}}
|
||||
<item>
|
||||
<title>{{ .Title }}</title>
|
||||
|
||||
<link>{{ .Permalink }}</link>
|
||||
<pubDate>{{ .Date.Format "Mon, 02 Jan 2006 15:04:05 -0700" | safeHTML }}</pubDate>
|
||||
{{ with .Site.Author.email }}<author>{{.}}{{ with $.Site.Author.name }} ({{.}}){{end}}</author>{{end}}
|
||||
<guid>{{ .Permalink }}</guid>
|
||||
<description>
|
||||
{{ $.Content | html }}
|
||||
{{ .Content | html }}
|
||||
Last modification : {{ .Lastmod }}
|
||||
</description>
|
||||
</item>
|
||||
{{- end }}
|
||||
</channel>
|
||||
</rss>
|
||||
</rss>
|
||||
|
||||
@ -7,7 +7,7 @@
|
||||
|
||||
{{ partial "nav-bar.html" . }}
|
||||
|
||||
<main class="content side-text-padding">
|
||||
<main class="content side-text-padding side-gutter">
|
||||
<article class="post {{ if ne .Params.dropcap false }}dropcase{{ end }}">
|
||||
<header class="post-header">
|
||||
<h1 class="post-title">{{ .Title }}</h1>
|
||||
@ -29,13 +29,16 @@
|
||||
{{- end }}
|
||||
{{ .Content }}
|
||||
</article>
|
||||
<nav class="end-nav card-container card">
|
||||
{{ with .PrevInSection }}
|
||||
{{ .Render "li-next" }}
|
||||
{{ end }}
|
||||
</nav>
|
||||
|
||||
{{ partial "footer.html" . }}
|
||||
|
||||
</main>
|
||||
<nav class="end-nav card-container card">
|
||||
{{ with .PrevInSection }}
|
||||
{{ .Render "li-next" }}
|
||||
{{ end }}
|
||||
</nav>
|
||||
{{ partial "footer.html" . }}
|
||||
|
||||
{{ partial "scripts.html" . }}
|
||||
</body>
|
||||
</html>
|
||||
|
||||
@ -1,13 +1,14 @@
|
||||
|
||||
<nav class="end-nav side-padding card-container card content">
|
||||
<nav class="end-nav card-container card content">
|
||||
{{ partial "openring-out.html" . }}
|
||||
|
||||
</nav>
|
||||
|
||||
|
||||
<footer class="content card card-container side-padding" >
|
||||
<footer class="content card card-container" >
|
||||
<h3>The Octet Press is <a href="{{ .Site.BaseURL }}about-me/">N07070's</a> blog.</h3>
|
||||
<small>It's self-hosted, low-tech, without javascript and static, as it should be.</small>
|
||||
<br>
|
||||
<sup><a href="{{ .Site.BaseURL}}/notes/why-no-js/" rel="nofollow">Why ?</a></sup>
|
||||
<br>
|
||||
<p> Page last modified on {{ .Lastmod }}</p>
|
||||
</footer>
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
<!-- License-Id: CC0-1.0 -->
|
||||
<section class="webring">
|
||||
<section class="webring side-padding">
|
||||
<h3>Articles from blogs I follow around the net</h3>
|
||||
<section class="articles">
|
||||
{{range .Articles}}
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
|
||||
<section class="webring">
|
||||
<section class="webring side-padding">
|
||||
<h3>Articles from blogs I follow around the net</h3>
|
||||
<section class="articles">
|
||||
|
||||
|
||||
@ -1,8 +1,8 @@
|
||||
name = "blogotheme"
|
||||
license = "AGPL"
|
||||
licenselink = "https://git.n07070.xyz/n07070/blog-theme/src/branch/main/LICENSE"
|
||||
licenselink = "https://git.n07070.xyz/n07070/blogotheme/src/branch/main/LICENSE"
|
||||
description = "The theme for my blog, used by the Hugo static website generator. It's based on the design of newspapers, brutalist web design, and inspired by the solar website built by low tech magazine."
|
||||
homepage = "https://git.n07070.xyz/n07070/blog-theme/"
|
||||
homepage = "https://git.n07070.xyz/n07070/blogotheme/"
|
||||
tags = ["Blog", "Personal", "Responsive", "Minimal", "Simple", "Clean", "Modern", "Technical", "Brutalist"]
|
||||
features = ["Responsive"]
|
||||
min_version = "0.41"
|
||||
|
||||
Loading…
Reference in New Issue
Block a user